Jump to

• Request
• Response

Create a dynamic workflow reference

post

/fscmRestApi/resources/11.13.18.05/publicSectorDynamicWorkflowReferences

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "GlobalTaskId":{
            "maxLength":500,
            "type":"string",
            "description":"The global task identifier of the associated dynamic workflow.",
            "nullable":false
        },
        "PreviousWorkflowReferenceKey":{
            "type":"integer",
            "description":"The unique identifier of the previous dynamic workflow reference.",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessCategory":{
            "maxLength":1000,
            "type":"string",
            "description":"The process category of the associated dynamic workflow.",
            "nullable":false
        },
        "ProcessDefinitionId":{
            "maxLength":500,
            "type":"string",
            "description":"The process definition identifier of the associated dynamic workflow.",
            "nullable":false
        },
        "ProcessDefinitionKey":{
            "maxLength":300,
            "type":"string",
            "description":"The process definition key of the associated dynamic workflow.",
            "nullable":false
        },
        "ProcessGroupId":{
            "maxLength":50,
            "type":"string",
            "description":"The process group identifier of the associated dynamic workflow.",
            "nullable":true
        },
        "ProcessInconsistent":{
            "maxLength":10,
            "type":"string",
            "description":"Indicates if the dynamic workflow process is in inconsistent state.",
            "nullable":true,
            "default":"ORA_N"
        },
        "ProcessInstanceId":{
            "maxLength":500,
            "type":"string",
            "description":"The process instance identifier of the associated dynamic workflow.",
            "nullable":true
        },
        "ProcessVersion":{
            "maxLength":50,
            "type":"string",
            "description":"The process version key of the associated dynamic workflow.",
            "nullable":true
        },
        "ProjectId":{
            "maxLength":500,
            "type":"string",
            "description":"The project identifier of the associated dynamic workflow.",
            "nullable":true
        },
        "SpaceName":{
            "maxLength":1000,
            "type":"string",
            "description":"The space name of the associated dynamic workflow.",
            "nullable":true
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the dynamic workflow reference.",
            "nullable":false,
            "default":"ORA_ACT"
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of transaction.",
            "nullable":false
        },
        "WorkflowAction":{
            "type":"string",
            "description":"The action to be performed on the associated dynamic workflow instance.",
            "nullable":true,
            "default":"ORA_INST",
            "x-queryable":false
        },
        "WorkflowActivityPayload":{
            "type":"string",
            "description":"The additional payload to be sent to the associated dynamic workflow instance.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "WorkflowPayload":{
            "type":"string",
            "description":"The payload to be sent to the associated dynamic workflow instance.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : publicSectorDynamicWorkflowReferences-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CrossReferenceKey":{
            "type":"integer",
            "description":"The unique identifier of the dynamic workflow reference.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "GlobalTaskId":{
            "maxLength":500,
            "type":"string",
            "description":"The global task identifier of the associated dynamic workflow.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousWorkflowReferenceKey":{
            "type":"integer",
            "description":"The unique identifier of the previous dynamic workflow reference.",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessCategory":{
            "maxLength":1000,
            "type":"string",
            "description":"The process category of the associated dynamic workflow.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessDefinitionId":{
            "maxLength":500,
            "type":"string",
            "description":"The process definition identifier of the associated dynamic workflow.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessDefinitionKey":{
            "maxLength":300,
            "type":"string",
            "description":"The process definition key of the associated dynamic workflow.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessGroupId":{
            "maxLength":50,
            "type":"string",
            "description":"The process group identifier of the associated dynamic workflow.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessInconsistent":{
            "maxLength":10,
            "type":"string",
            "description":"Indicates if the dynamic workflow process is in inconsistent state.",
            "nullable":true,
            "default":"ORA_N",
            "x-queryable":true
        },
        "ProcessInstanceId":{
            "maxLength":500,
            "type":"string",
            "description":"The process instance identifier of the associated dynamic workflow.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessVersion":{
            "maxLength":50,
            "type":"string",
            "description":"The process version key of the associated dynamic workflow.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "maxLength":500,
            "type":"string",
            "description":"The project identifier of the associated dynamic workflow.",
            "nullable":true,
            "x-queryable":true
        },
        "SpaceName":{
            "maxLength":1000,
            "type":"string",
            "description":"The space name of the associated dynamic workflow.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the dynamic workflow reference.",
            "nullable":false,
            "default":"ORA_ACT",
            "x-queryable":true
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkflowAction":{
            "type":"string",
            "description":"The action to be performed on the associated dynamic workflow instance.",
            "nullable":true,
            "default":"ORA_INST",
            "x-queryable":false
        },
        "WorkflowActivityPayload":{
            "type":"string",
            "description":"The additional payload to be sent to the associated dynamic workflow instance.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "WorkflowPayload":{
            "type":"string",
            "description":"The payload to be sent to the associated dynamic workflow instance.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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