Get all workflows
get
/fscmRestApi/resources/11.13.18.05/hedWorkflowDefinitions
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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- KeywordFinder Finds all workflow instances that match the keyword criteria specified.
Finder Variables- Keyword; string; Keyword; string; to search based on workflow name, institution name, category name, or workflow status.
- PrimaryKey Finds all workflow instances that match the primary key criteria specified.
Finder Variables- WorkflowId; integer; Unique identifier for a workflow instance.
- UniqueWorkflowProcessCodeFinder Finds all workflow instances that match the process code specified.
Finder Variables- Keyword; string; Keyword; string; to search based on process code.
- KeywordFinder Finds all workflow instances that match the keyword criteria specified.
-
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:- CategoryCode; string; The unique code for a category associated with a workflow process.
- CategoryId; integer; The unique identifier for a category associated with a workflow process. Examples of categories can be Admissions or Student Enrollment.
- CategoryName; string; The category of a workflow, such as enrollment or billing.
- Comments; string; User's comment on the workflow definition.
- ExternalWorkflowUuid; string; Identifier for workflow definition loaded in an external workflow engine.
- InstitutionId; integer; The unique identifier for an institution associated with a workflow process.
- InstitutionName; string; The institution for a workflow.
- PrimaryObjectTypeCode; string; Primary business object that's used in the workflow.
- PrimaryObjectTypeMeaning; string; Primary business object that's used in the workflow. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_OBJECT_TYPE.
- StatusCode; string; The code for a workflow status. A list of accepted values is defined in the lookup type ORA_HEY_WORKFLOW_STATUS.
- StatusMeaning; string; The status for a workflow, such as draft or published. A list of accepted values is defined in the lookup type ORA_HEY_WORKFLOW_STATUS.
- StatusSchemeCode; string; The unique code of the status scheme.
- StatusSchemeId; integer; Status scheme identifier used in the workflow.
- StatusSchemeName; string; The name of the status scheme.
- TemplatePurposeCode; string; Purpose of the workflow template. For example, ORA_HEY_EVALUATIONS indicates that the workflow template is used for admissions applications evaluations.
- TemplatePurposeMeaning; string; Purpose of the workflow template. A list of accepted values is defined in the lookup type ORA_HEY_WF_TEMPLATE_PURPOSE.
- VersionDescription; string; Name of the workflow definition version.
- VersionName; string; Description of the workflow definition version.
- VersionNumber; integer; The number that identifies the version of a workflow. When the user changes a workflow, the application automatically assigns a new version number to the workflow.
- WorkflowId; integer; The unique identifier for a workflow process.
- WorkflowName; string; The name of a workflow.
- WorkflowProcessCode; string; The unique code for a workflow process.
- WorkflowTemplateId; integer; The unique identifier for a workflow template associated with a workflow process.
- WorkflowTemplateName; string; The name for a workflow template associated with a workflow process.
- WorkflowTypeCode; string; The code indicating the type of workflow for a workflow process. A list of accepted values is defined in the lookup type ORA_HEY_WORKFLOW_TYPE.
- WorkflowTypeMeaning; string; The type of workflow, such as a workflow created from a template or one created from a blank canvas. A list of accepted values is defined in the lookup type ORA_HEY_WORKFLOW_TYPE.
-
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : hedWorkflowDefinitions
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedWorkflowDefinitions-item-response
Type:
Show Source
object
-
CategoryCode: string
Title:
Category Code
Maximum Length:30
The unique code for a category associated with a workflow process. -
CategoryId: integer
(int64)
Title:
Category ID
The unique identifier for a category associated with a workflow process. Examples of categories can be Admissions or Student Enrollment. -
CategoryName: string
Title:
Category
Read Only:true
Maximum Length:50
The category of a workflow, such as enrollment or billing. -
Comments: string
Title:
Comment
User's comment on the workflow definition. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Indicates who created a workflow process. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which a workflow process was created. -
ExternalWorkflowUuid: string
Title:
External Workflow Identifier
Maximum Length:36
Identifier for workflow definition loaded in an external workflow engine. -
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier for an institution associated with a workflow process. -
InstitutionName: string
Title:
Institution
Maximum Length:50
The institution for a workflow. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which a workflow process was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Indicates who last updated a workflow process. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryObjectTypeCode: string
Title:
Primary Object Type Code
Maximum Length:30
Primary business object that's used in the workflow. -
PrimaryObjectTypeMeaning: string
Title:
Primary Object Type
Read Only:true
Maximum Length:80
Primary business object that's used in the workflow. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_OBJECT_TYPE. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The code for a workflow status. A list of accepted values is defined in the lookup type ORA_HEY_WORKFLOW_STATUS. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
The status for a workflow, such as draft or published. A list of accepted values is defined in the lookup type ORA_HEY_WORKFLOW_STATUS. -
StatusSchemeCode: string
Title:
Status Scheme Code
Maximum Length:30
The unique code of the status scheme. -
StatusSchemeId: integer
(int64)
Status scheme identifier used in the workflow.
-
StatusSchemeName: string
Title:
Status Scheme Name
Read Only:true
Maximum Length:60
The name of the status scheme. -
TemplatePurposeCode: string
Title:
Template Purpose Code
Maximum Length:30
Purpose of the workflow template. For example, ORA_HEY_EVALUATIONS indicates that the workflow template is used for admissions applications evaluations. -
TemplatePurposeMeaning: string
Title:
Template Purpose
Read Only:true
Maximum Length:80
Purpose of the workflow template. A list of accepted values is defined in the lookup type ORA_HEY_WF_TEMPLATE_PURPOSE. -
VersionDescription: string
Title:
Description
Maximum Length:240
Name of the workflow definition version. -
VersionName: string
Title:
Name
Maximum Length:50
Description of the workflow definition version. -
VersionNumber: integer
(int32)
Title:
Version Number
Read Only:true
The number that identifies the version of a workflow. When the user changes a workflow, the application automatically assigns a new version number to the workflow. -
WorkflowBpmnContent: string
(byte)
Title:
Workflow BPMN Content
Read Only:true
Workflow definition in business process model and notation format. -
WorkflowContent: string
(byte)
Title:
Workflow Content
The content of a workflow process, such as the steps of the workflow and their properties. Examples of such properties are whether the workflow step is an event that triggers the workflow or a task that a user performs. -
WorkflowDescription: string
Title:
Description
Maximum Length:240
The description of a workflow. -
WorkflowId: integer
(int64)
Title:
Workflow ID
Read Only:true
The unique identifier for a workflow process. -
WorkflowName: string
Title:
Name
Maximum Length:60
The name of a workflow. -
WorkflowProcessCode: string
Title:
Workflow Process Code
Maximum Length:30
The unique code for a workflow process. -
WorkflowTemplateId: integer
(int64)
Title:
Workflow Template ID
The unique identifier for a workflow template associated with a workflow process. -
WorkflowTemplateName: string
Title:
Workflow Template Name
Read Only:true
The name for a workflow template associated with a workflow process. -
WorkflowTypeCode: string
Title:
Workflow Type Code
Maximum Length:30
The code indicating the type of workflow for a workflow process. A list of accepted values is defined in the lookup type ORA_HEY_WORKFLOW_TYPE. -
WorkflowTypeMeaning: string
Title:
Workflow Type
Read Only:true
Maximum Length:80
The type of workflow, such as a workflow created from a template or one created from a blank canvas. A list of accepted values is defined in the lookup type ORA_HEY_WORKFLOW_TYPE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.