Get a workflow
get
/fscmRestApi/resources/11.13.18.05/hedWorkflowDefinitions/{hedWorkflowDefinitionsUniqID}
Request
Path Parameters
-
hedWorkflowDefinitionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Workflow Definitions resource and used to uniquely identify an instance of Workflow Definitions. The client should not generate the hash key value. Instead, the client should query on the Workflow Definitions collection resource in order to navigate to a specific instance of Workflow Definitions to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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.
Links
- academicInstitutionsLOV
-
The list of values for workflow institution.
- hedWorkflowStatusSchemesLOV
-
The list of values for workflow status scheme.
- primaryObjectTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_PRIMARY_OBJECT_TYPE
The list of values for primary object type code. - finder:
- studentManagementCategoriesLOV
-
The list of values for workflow category.
- templatePurposeCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_WF_TEMPLATE_PURPOSE
The list of values for template purpose code. - finder:
- workflowStatusCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_WORKFLOW_STATUS
The list of values for workflow status code. - finder:
- workflowTypeCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_WORKFLOW_TYPE
The list of values for workflow type code. - finder: