Jump to

• Request
• Response

Get all information about workflow tasks and their associated application data

get

/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTasks

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a record by the primary key criteria. Finder Variables:
    • TaskId; integer; The task ID for the workflow task.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorWorklistTasks

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorWorklistTasks-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorWorklistTasks-item

{
    "items":{
        "$ref":"#/definitions/publicSectorWorklistTasks-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorWorklistTasks-item

Type: object

Show Source

• Classification(optional): string
  Maximum Length: 10

  The classification for the associated application.
• links(optional): array Items
  Title: Items

  Link Relations
• ProcessId(optional): integer(int64)
  The workflow process ID to which the workflow task belongs.
• PropertyAddress1(optional): string
  Maximum Length: 1000

  The first line of property address for the associated application.
• PropertyAddress2(optional): string
  Maximum Length: 1000

  The other lines of property address for the associated application.
• PropertyCity(optional): string
  Maximum Length: 100

  The city in the property address.
• PropertyPostalCode(optional): string
  Maximum Length: 100

  The postal code in the property address.
• PropertyState(optional): string
  Maximum Length: 100

  The state in the property address.
• PropertyStreetNameConcat(optional): string
  Maximum Length: 500

  The street direction, street name, street type and street suffix in the property address.
• PropertyStreetNumber(optional): string
  Maximum Length: 100

  The street number in the property address.
• RecordDesc(optional): string
  Maximum Length: 1000

  The record description for the associated application.
• RecordId(optional): string
  Maximum Length: 100

  The record ID for the associated application.
• RecordKey(optional): integer(int64)
  The record key for the associated application.
• RecordType(optional): string
  Maximum Length: 100

  The record type for the associated application.
• SubClassification(optional): string
  Maximum Length: 100

  The sub-classification for the associated application.
• TaskCreatedDate(optional): string(date-time)
  The date on which the workflow task got created.
• TaskDueDate(optional): string(date-time)
  The due date to complete the workflow task.
• TaskId(optional): integer(int64)
  The task ID for the workflow task.
• TaskName(optional): string
  Maximum Length: 400

  The name for the workflow task.
• TaskPriority(optional): integer(int32)
  The priority for the workflow task.
• TaskStatus(optional): string
  Maximum Length: 50

  The status of the workflow task.
• TaskUpdatedDate(optional): string(date-time)
  The date on which the workflow task got updated.

{
    "properties":{
        "Classification":{
            "maxLength":10,
            "type":"string",
            "description":"The classification for the associated application."
        },
        "ProcessId":{
            "format":"int64",
            "type":"integer",
            "description":"The workflow process ID to which the workflow task belongs."
        },
        "PropertyAddress1":{
            "maxLength":1000,
            "type":"string",
            "description":"The first line of property address for the associated application."
        },
        "PropertyAddress2":{
            "maxLength":1000,
            "type":"string",
            "description":"The other lines of property address for the associated application."
        },
        "PropertyCity":{
            "maxLength":100,
            "type":"string",
            "description":"The city in the property address."
        },
        "PropertyPostalCode":{
            "maxLength":100,
            "type":"string",
            "description":"The postal code in the property address."
        },
        "PropertyState":{
            "maxLength":100,
            "type":"string",
            "description":"The state in the property address."
        },
        "PropertyStreetNameConcat":{
            "maxLength":500,
            "type":"string",
            "description":"The street direction, street name, street type and street suffix in the property address."
        },
        "PropertyStreetNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The street number in the property address."
        },
        "RecordDesc":{
            "maxLength":1000,
            "type":"string",
            "description":"The record description for the associated application."
        },
        "RecordId":{
            "maxLength":100,
            "type":"string",
            "description":"The record ID for the associated application."
        },
        "RecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The record key for the associated application."
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The record type for the associated application."
        },
        "SubClassification":{
            "maxLength":100,
            "type":"string",
            "description":"The sub-classification for the associated application."
        },
        "TaskCreatedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the workflow task got created."
        },
        "TaskDueDate":{
            "format":"date-time",
            "type":"string",
            "description":"The due date to complete the workflow task."
        },
        "TaskId":{
            "format":"int64",
            "type":"integer",
            "description":"The task ID for the workflow task."
        },
        "TaskName":{
            "maxLength":400,
            "type":"string",
            "description":"The name for the workflow task."
        },
        "TaskPriority":{
            "format":"int32",
            "type":"integer",
            "description":"The priority for the workflow task."
        },
        "TaskStatus":{
            "maxLength":50,
            "type":"string",
            "description":"The status of the workflow task."
        },
        "TaskUpdatedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the workflow task got updated."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top