Create a dynamic workflow reference
post
/fscmRestApi/resources/11.13.18.05/publicSectorDynamicWorkflowReferences
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency. -
GlobalTaskId: string
Maximum Length:
500
The global task identifier of the associated dynamic workflow. -
PreviousWorkflowReferenceKey: integer
The unique identifier of the previous dynamic workflow reference.
-
ProcessCategory: string
Maximum Length:
1000
The process category of the associated dynamic workflow. -
ProcessDefinitionId: string
Maximum Length:
500
The process definition identifier of the associated dynamic workflow. -
ProcessDefinitionKey: string
Maximum Length:
300
The process definition key of the associated dynamic workflow. -
ProcessGroupId: string
Maximum Length:
50
The process group identifier of the associated dynamic workflow. -
ProcessInconsistent: string
Maximum Length:
10
Default Value:ORA_N
Indicates if the dynamic workflow process is in inconsistent state. -
ProcessInstanceId: string
Maximum Length:
500
The process instance identifier of the associated dynamic workflow. -
ProcessVersion: string
Maximum Length:
50
The process version key of the associated dynamic workflow. -
ProjectId: string
Maximum Length:
500
The project identifier of the associated dynamic workflow. -
SpaceName: string
Maximum Length:
1000
The space name of the associated dynamic workflow. -
Status: string
Maximum Length:
15
Default Value:ORA_ACT
The status of the dynamic workflow reference. -
TransactionKey: integer
(int64)
The unique identifier of the transaction.
-
TransactionType: string
Maximum Length:
15
The type of transaction. -
WorkflowAction: string
Default Value:
ORA_INST
The action to be performed on the associated dynamic workflow instance. -
WorkflowActivityPayload: string
The additional payload to be sent to the associated dynamic workflow instance.
-
WorkflowPayload: string
The payload to be sent to the associated dynamic workflow instance.
Response
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 : publicSectorDynamicWorkflowReferences-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
CrossReferenceKey: integer
(int64)
Read Only:
true
The unique identifier of the dynamic workflow reference. -
GlobalTaskId: string
Maximum Length:
500
The global task identifier of the associated dynamic workflow. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PreviousWorkflowReferenceKey: integer
The unique identifier of the previous dynamic workflow reference.
-
ProcessCategory: string
Maximum Length:
1000
The process category of the associated dynamic workflow. -
ProcessDefinitionId: string
Maximum Length:
500
The process definition identifier of the associated dynamic workflow. -
ProcessDefinitionKey: string
Maximum Length:
300
The process definition key of the associated dynamic workflow. -
ProcessGroupId: string
Maximum Length:
50
The process group identifier of the associated dynamic workflow. -
ProcessInconsistent: string
Maximum Length:
10
Default Value:ORA_N
Indicates if the dynamic workflow process is in inconsistent state. -
ProcessInstanceId: string
Maximum Length:
500
The process instance identifier of the associated dynamic workflow. -
ProcessVersion: string
Maximum Length:
50
The process version key of the associated dynamic workflow. -
ProjectId: string
Maximum Length:
500
The project identifier of the associated dynamic workflow. -
SpaceName: string
Maximum Length:
1000
The space name of the associated dynamic workflow. -
Status: string
Maximum Length:
15
Default Value:ORA_ACT
The status of the dynamic workflow reference. -
TransactionKey: integer
(int64)
The unique identifier of the transaction.
-
TransactionType: string
Maximum Length:
15
The type of transaction. -
WorkflowAction: string
Default Value:
ORA_INST
The action to be performed on the associated dynamic workflow instance. -
WorkflowActivityPayload: string
The additional payload to be sent to the associated dynamic workflow instance.
-
WorkflowPayload: string
The payload to be sent to the associated dynamic workflow instance.
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.