GET Worklist/Metadata?identifier={identifier}&userLogin={userLogin}&worklistType={worklistType}&culture={culture}&global={global}&forceRefresh={forceRefresh}

Request Information

URI Parameters

Name	Type	Additional information
identifier	string	Required
userLogin	string	None.
worklistType	WorklistType	Default value is Legacy
culture	string	None.
global	boolean	Default value is False
forceRefresh	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Metadata

Name	Description	Type	Additional information
BaseType	Gets or sets the base type	string	None.
KeyColumn	Gets or sets the key column name.	string	None.
RefreshRate	Gets or sets the refresh rate (in seconds).	integer	None.
Columns	Gets or sets the columns.	Collection of ListColumn	None.
Filters	Gets or sets the filters.	Collection of ListFilter	None.
GroupByColumns	Grouping columns of the QBE folder	Collection of GroupByColumn	None.
ParentIdentifier	Gets or sets the parent identifier.	string	None.
DefaultSorts	Gets or sets default sorts	Collection of ListSort	None.

Response Formats

application/json, text/json

Sample:

{
  "BaseType": "sample string 1",
  "KeyColumn": "sample string 2",
  "RefreshRate": 1,
  "Columns": [
    {
      "Name": "sample string 1",
      "Type": "sample string 2",
      "Label": "sample string 3",
      "Order": 1,
      "Width": 1.0,
      "SortOrder": 1,
      "SortDirection": 1,
      "IsHidden": true
    },
    {
      "Name": "sample string 1",
      "Type": "sample string 2",
      "Label": "sample string 3",
      "Order": 1,
      "Width": 1.0,
      "SortOrder": 1,
      "SortDirection": 1,
      "IsHidden": true
    }
  ],
  "Filters": [
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Value": "sample string 3",
      "ValueList": [
        "sample string 1",
        "sample string 2"
      ],
      "SecondValue": "sample string 4",
      "IsLocalizable": true,
      "Group": 6
    },
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Value": "sample string 3",
      "ValueList": [
        "sample string 1",
        "sample string 2"
      ],
      "SecondValue": "sample string 4",
      "IsLocalizable": true,
      "Group": 6
    }
  ],
  "GroupByColumns": [
    {
      "ColumnName": "sample string 1",
      "GroupType": 0
    },
    {
      "ColumnName": "sample string 1",
      "GroupType": 0
    }
  ],
  "ParentIdentifier": "sample string 3",
  "DefaultSorts": [
    {
      "Column": "sample string 1",
      "Direction": 1
    },
    {
      "Column": "sample string 1",
      "Direction": 1
    }
  ]
}

application/xml, text/xml

Sample:

<Metadata xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Worklists">
  <BaseType>sample string 1</BaseType>
  <Columns>
    <ListColumn>
      <IsHidden>true</IsHidden>
      <Label>sample string 3</Label>
      <Name>sample string 1</Name>
      <Order>1</Order>
      <SortDirection>1</SortDirection>
      <SortOrder>1</SortOrder>
      <Type>sample string 2</Type>
      <Width>1</Width>
    </ListColumn>
    <ListColumn>
      <IsHidden>true</IsHidden>
      <Label>sample string 3</Label>
      <Name>sample string 1</Name>
      <Order>1</Order>
      <SortDirection>1</SortDirection>
      <SortOrder>1</SortOrder>
      <Type>sample string 2</Type>
      <Width>1</Width>
    </ListColumn>
  </Columns>
  <DefaultSorts>
    <ListSort>
      <Column>sample string 1</Column>
      <Direction>1</Direction>
    </ListSort>
    <ListSort>
      <Column>sample string 1</Column>
      <Direction>1</Direction>
    </ListSort>
  </DefaultSorts>
  <Filters>
    <ListFilter>
      <Column>sample string 1</Column>
      <Group>6</Group>
      <IsLocalizable>true</IsLocalizable>
      <Operator>sample string 2</Operator>
      <SecondValue>sample string 4</SecondValue>
      <Value>sample string 3</Value>
      <ValueList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ValueList>
    </ListFilter>
    <ListFilter>
      <Column>sample string 1</Column>
      <Group>6</Group>
      <IsLocalizable>true</IsLocalizable>
      <Operator>sample string 2</Operator>
      <SecondValue>sample string 4</SecondValue>
      <Value>sample string 3</Value>
      <ValueList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ValueList>
    </ListFilter>
  </Filters>
  <GroupByColumns>
    <GroupByColumn>
      <ColumnName>sample string 1</ColumnName>
      <GroupType>Same</GroupType>
    </GroupByColumn>
    <GroupByColumn>
      <ColumnName>sample string 1</ColumnName>
      <GroupType>Same</GroupType>
    </GroupByColumn>
  </GroupByColumns>
  <KeyColumn>sample string 2</KeyColumn>
  <ParentIdentifier>sample string 3</ParentIdentifier>
  <RefreshRate>1</RefreshRate>
</Metadata>