Jump to

• Request
• Response

Get all workflow requests

get

/fscmRestApi/resources/11.13.18.05/hedWorkflowRequests

Request

Query Parameters

• 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 all workflow requests that match the primary key criteria specified.
    Finder Variables
    • WorkflowRequestId; integer; Unique identifier for a workflow request.
• 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.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• 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 fields. 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActivityContext; string; Contextual information related to a workflow process activity.
  • ActivityIdentifier; string; Unique identifier for an activity in an external workflow processing engine.
  • CreatedBy; string; Indicates who created a workflow request.
  • CreationDate; string; The date on which a workflow request was created.
  • ExternalProcessUuid; string; The identifier of the workflow process executing in an external workflow engine.
  • LastUpdateDate; string; Indicates who last updated a workflow request.
  • LastUpdatedBy; string; The date on which a workflow request was last updated.
  • RequestStatusCode; string; Status for a workflow request, such as submitted or processing. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_STATUS.
  • RequestStatusCodeMeaning; string; Code for a workflow request status. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_STATUS.
  • RequestTypeCode; string; Type of request for a workflow request, such as user task or checklist. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_TYPE.
  • RequestTypeCodeMeaning; string; Code for a workflow request type. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_TYPE.
  • RequestTypeId; integer; The identifier of a request type instance. For example, user task identifier, business rule identifier, and so on.
  • WorkflowRequestId; integer; Unique identifier for a workflow request.
• 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".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : hedWorkflowRequests

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  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: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/hedWorkflowRequests-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hedWorkflowRequests-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/hedWorkflowRequests-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hedWorkflowRequests-item-response

Type: object

Show Source

• ActivityContext: string
  Title: Activity Context

  Maximum Length: 255

  Contextual information related to a workflow process activity.
• ActivityIdentifier: string
  Title: Activity Identifier

  Maximum Length: 36

  Unique identifier for an activity in an external workflow processing engine.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Indicates who created a workflow request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date on which a workflow request was created.
• ExternalProcessUuid: string
  Title: External Process ID

  Maximum Length: 36

  The identifier of the workflow process executing in an external workflow engine.
• hedWorkflowRequestActions: array Workflow Request Actions
  Title: Workflow Request Actions

  The workflow request actions resource is used to view actions performed by the workflow process for a workflow request.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Indicates who last updated a workflow request.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date on which a workflow request was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestStatusCode: string
  Title: Request Status Code

  Maximum Length: 30

  Default Value: ORA_HEY_IN_PROGRESS

  Status for a workflow request, such as submitted or processing. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_STATUS.
• RequestStatusCodeMeaning: string
  Title: Request Status

  Read Only: true

  Maximum Length: 80

  Code for a workflow request status. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_STATUS.
• RequestTypeCode: string
  Title: Request Type Code

  Maximum Length: 30

  Type of request for a workflow request, such as user task or checklist. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_TYPE.
• RequestTypeCodeMeaning: string
  Title: Request Type

  Read Only: true

  Maximum Length: 80

  Code for a workflow request type. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_TYPE.
• RequestTypeId: integer (int64)
  Title: Request Type ID

  The identifier of a request type instance. For example, user task identifier, business rule identifier, and so on.
• WorkflowInstanceId: integer
  Title: Workflow Instance ID

  Read Only: true

  Unique identifier for a workflow instance.
• WorkflowRequestId: integer (int64)
  Title: Workflow Request ID

  Unique identifier for a workflow request.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date on which a workflow request was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityContext":{
            "title":"Activity Context",
            "maxLength":"255",
            "type":"string",
            "description":"Contextual information related to a workflow process activity.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "ActivityContextClob"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which a workflow request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "hedWorkflowRequestActions":{
            "title":"Workflow Request Actions",
            "type":"array",
            "description":"The workflow request actions resource is used to view actions performed by the workflow process for a workflow request.",
            "items":{
                "$ref":"#/components/schemas/hedWorkflowRequests-hedWorkflowRequestActions-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates who created a workflow request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityIdentifier":{
            "title":"Activity Identifier",
            "maxLength":"36",
            "type":"string",
            "description":"Unique identifier for an activity in an external workflow processing engine.",
            "nullable":false,
            "x-queryable":true
        },
        "RequestTypeId":{
            "title":"Request Type ID",
            "type":"integer",
            "description":"The identifier of a request type instance. For example, user task identifier, business rule identifier, and so on.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestStatusCodeMeaning":{
            "title":"Request Status",
            "maxLength":"80",
            "type":"string",
            "description":"Code for a workflow request status. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkflowRequestId":{
            "title":"Workflow Request ID",
            "type":"integer",
            "description":"Unique identifier for a workflow request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RequestTypeCodeMeaning":{
            "title":"Request Type",
            "maxLength":"80",
            "type":"string",
            "description":"Code for a workflow request type. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestStatusCode":{
            "title":"Request Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status for a workflow request, such as submitted or processing. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_STATUS.",
            "nullable":false,
            "default":"ORA_HEY_IN_PROGRESS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalProcessUuid":{
            "title":"External Process ID",
            "maxLength":"36",
            "type":"string",
            "description":"The identifier of the workflow process executing in an external workflow engine.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkflowInstanceId":{
            "title":"Workflow Instance ID",
            "type":"integer",
            "description":"Unique identifier for a workflow instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequestTypeCode":{
            "title":"Request Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Type of request for a workflow request, such as user task or checklist. A list of accepted values is defined in the lookup type ORA_HEY_WF_REQUEST_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates who last updated a workflow request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Workflow Request Actions

Type: array

Title: Workflow Request Actions

The workflow request actions resource is used to view actions performed by the workflow process for a workflow request.

Show Source

• Array of: object hedWorkflowRequests-hedWorkflowRequestActions-item-response

{
    "title":"Workflow Request Actions",
    "type":"array",
    "description":"The workflow request actions resource is used to view actions performed by the workflow process for a workflow request.",
    "items":{
        "$ref":"#/components/schemas/hedWorkflowRequests-hedWorkflowRequestActions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hedWorkflowRequests-hedWorkflowRequestActions-item-response

Type: object

Show Source

• ActionContext: string
  Title: Action Context

  Maximum Length: 255

  Contextual information related to a workflow request action.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Indicates who created a workflow request action.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date on which a workflow request action was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which a workflow request action was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Indicates who last updated a workflow request action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageIdentifier: string
  Title: Message Identifier

  Maximum Length: 64

  The identifier of a message related to the action performed on a workflow request.
• MessageText: string
  Title: Message Text

  Maximum Length: 80

  A message related to the action performed on a workflow request.
• RequestActionCode: string
  Title: Request Action Code

  Maximum Length: 30

  Code for an action performed on a workflow request.
• RequestActionCodeMeaning: string
  Title: Request Action

  Read Only: true

  Maximum Length: 80

  Action performed on a workflow request. For example, progress update, error, warning, and so on.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  Sequence of an action performed on a workflow request.
• WorkflowRequestActionId: integer (int64)
  Title: Request Action ID

  Unique identifier for a workflow request action.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates who last updated a workflow request action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestActionCodeMeaning":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"Action performed on a workflow request. For example, progress update, error, warning, and so on.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which a workflow request action was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates who created a workflow request action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestActionCode":{
            "title":"Request Action Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for an action performed on a workflow request.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkflowRequestActionId":{
            "title":"Request Action ID",
            "type":"integer",
            "description":"Unique identifier for a workflow request action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Sequence of an action performed on a workflow request.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MessageIdentifier":{
            "title":"Message Identifier",
            "maxLength":"64",
            "type":"string",
            "description":"The identifier of a message related to the action performed on a workflow request.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageText":{
            "title":"Message Text",
            "maxLength":"80",
            "type":"string",
            "description":"A message related to the action performed on a workflow request.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionContext":{
            "title":"Action Context",
            "maxLength":"255",
            "type":"string",
            "description":"Contextual information related to a workflow request action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionContextClob"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which a workflow request action was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top