Jump to

• Request
• Response

Create a dynamic workflow reference

post

/fscmRestApi/resources/11.13.18.05/publicSectorDynamicWorkflowReferences

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorDynamicWorkflowReferences-item

Type: object

Show Source

• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• CrossReferenceKey(optional): integer(int64)
  The unique identifier of the dynamic workflow reference.
• GlobalTaskId(optional): string
  Maximum Length: 500

  The global task identifier of the associated dynamic workflow.
• LastUpdateDate(optional): string(date-time)
  The date and time when the row was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• ProcessCategory(optional): string
  Maximum Length: 1000

  The process category of the associated dynamic workflow.
• ProcessDefinitionId(optional): string
  Maximum Length: 500

  The process definition identifier of the associated dynamic workflow.
• ProcessDefinitionKey(optional): string
  Maximum Length: 300

  The process definition key of the associated dynamic workflow.
• ProcessInconsistent(optional): string
  Maximum Length: 10

  Indicates if the dynamic workflow process is in inconsistent state.
• ProcessInstanceId(optional): string
  Maximum Length: 500

  The process instance identifier of the associated dynamic workflow.
• ProcessVersion(optional): string
  Maximum Length: 50

  The process version key of the associated dynamic workflow.
• ProjectId(optional): string
  Maximum Length: 500

  The project identifier of the associated dynamic workflow.
• SpaceName(optional): string
  Maximum Length: 1000

  The space name of the associated dynamic workflow.
• Status(optional): string
  Maximum Length: 15

  The status of the dynamic workflow reference.
• TransactionKey(optional): integer(int64)
  The unique identifier of the transaction.
• TransactionType(optional): string
  Maximum Length: 15

  The type of transaction.
• WorkflowAction(optional): string
  The action to be performed on the associated dynamic workflow instance.
• WorkflowActivityPayload(optional): string
  The additional payload to be sent to the associated dynamic workflow instance.
• WorkflowPayload(optional): string
  The payload to be sent to the associated dynamic workflow instance.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "description":"The date and time when the row was created.",
            "type":"string",
            "format":"date-time"
        },
        "CrossReferenceKey":{
            "description":"The unique identifier of the dynamic workflow reference.",
            "type":"integer",
            "format":"int64"
        },
        "GlobalTaskId":{
            "description":"The global task identifier of the associated dynamic workflow.",
            "type":"string",
            "maxLength":500
        },
        "LastUpdateDate":{
            "description":"The date and time when the row was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "ProcessCategory":{
            "description":"The process category of the associated dynamic workflow.",
            "type":"string",
            "maxLength":1000
        },
        "ProcessDefinitionId":{
            "description":"The process definition identifier of the associated dynamic workflow.",
            "type":"string",
            "maxLength":500
        },
        "ProcessDefinitionKey":{
            "description":"The process definition key of the associated dynamic workflow.",
            "type":"string",
            "maxLength":300
        },
        "ProcessInconsistent":{
            "description":"Indicates if the dynamic workflow process is in inconsistent state.",
            "type":"string",
            "maxLength":10
        },
        "ProcessInstanceId":{
            "description":"The process instance identifier of the associated dynamic workflow.",
            "type":"string",
            "maxLength":500
        },
        "ProcessVersion":{
            "description":"The process version key of the associated dynamic workflow.",
            "type":"string",
            "maxLength":50
        },
        "ProjectId":{
            "description":"The project identifier of the associated dynamic workflow.",
            "type":"string",
            "maxLength":500
        },
        "SpaceName":{
            "description":"The space name of the associated dynamic workflow.",
            "type":"string",
            "maxLength":1000
        },
        "Status":{
            "description":"The status of the dynamic workflow reference.",
            "type":"string",
            "maxLength":15
        },
        "TransactionKey":{
            "description":"The unique identifier of the transaction.",
            "type":"integer",
            "format":"int64"
        },
        "TransactionType":{
            "description":"The type of transaction.",
            "type":"string",
            "maxLength":15
        },
        "WorkflowAction":{
            "description":"The action to be performed on the associated dynamic workflow instance.",
            "type":"string"
        },
        "WorkflowActivityPayload":{
            "description":"The additional payload to be sent to the associated dynamic workflow instance.",
            "type":"string"
        },
        "WorkflowPayload":{
            "description":"The payload to be sent to the associated dynamic workflow instance.",
            "type":"string"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorDynamicWorkflowReferences-item

Type: object

Show Source

• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• CrossReferenceKey(optional): integer(int64)
  The unique identifier of the dynamic workflow reference.
• GlobalTaskId(optional): string
  Maximum Length: 500

  The global task identifier of the associated dynamic workflow.
• LastUpdateDate(optional): string(date-time)
  The date and time when the row was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• ProcessCategory(optional): string
  Maximum Length: 1000

  The process category of the associated dynamic workflow.
• ProcessDefinitionId(optional): string
  Maximum Length: 500

  The process definition identifier of the associated dynamic workflow.
• ProcessDefinitionKey(optional): string
  Maximum Length: 300

  The process definition key of the associated dynamic workflow.
• ProcessInconsistent(optional): string
  Maximum Length: 10

  Indicates if the dynamic workflow process is in inconsistent state.
• ProcessInstanceId(optional): string
  Maximum Length: 500

  The process instance identifier of the associated dynamic workflow.
• ProcessVersion(optional): string
  Maximum Length: 50

  The process version key of the associated dynamic workflow.
• ProjectId(optional): string
  Maximum Length: 500

  The project identifier of the associated dynamic workflow.
• SpaceName(optional): string
  Maximum Length: 1000

  The space name of the associated dynamic workflow.
• Status(optional): string
  Maximum Length: 15

  The status of the dynamic workflow reference.
• TransactionKey(optional): integer(int64)
  The unique identifier of the transaction.
• TransactionType(optional): string
  Maximum Length: 15

  The type of transaction.
• WorkflowAction(optional): string
  The action to be performed on the associated dynamic workflow instance.
• WorkflowActivityPayload(optional): string
  The additional payload to be sent to the associated dynamic workflow instance.
• WorkflowPayload(optional): string
  The payload to be sent to the associated dynamic workflow instance.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "description":"The date and time when the row was created.",
            "type":"string",
            "format":"date-time"
        },
        "CrossReferenceKey":{
            "description":"The unique identifier of the dynamic workflow reference.",
            "type":"integer",
            "format":"int64"
        },
        "GlobalTaskId":{
            "description":"The global task identifier of the associated dynamic workflow.",
            "type":"string",
            "maxLength":500
        },
        "LastUpdateDate":{
            "description":"The date and time when the row was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "ProcessCategory":{
            "description":"The process category of the associated dynamic workflow.",
            "type":"string",
            "maxLength":1000
        },
        "ProcessDefinitionId":{
            "description":"The process definition identifier of the associated dynamic workflow.",
            "type":"string",
            "maxLength":500
        },
        "ProcessDefinitionKey":{
            "description":"The process definition key of the associated dynamic workflow.",
            "type":"string",
            "maxLength":300
        },
        "ProcessInconsistent":{
            "description":"Indicates if the dynamic workflow process is in inconsistent state.",
            "type":"string",
            "maxLength":10
        },
        "ProcessInstanceId":{
            "description":"The process instance identifier of the associated dynamic workflow.",
            "type":"string",
            "maxLength":500
        },
        "ProcessVersion":{
            "description":"The process version key of the associated dynamic workflow.",
            "type":"string",
            "maxLength":50
        },
        "ProjectId":{
            "description":"The project identifier of the associated dynamic workflow.",
            "type":"string",
            "maxLength":500
        },
        "SpaceName":{
            "description":"The space name of the associated dynamic workflow.",
            "type":"string",
            "maxLength":1000
        },
        "Status":{
            "description":"The status of the dynamic workflow reference.",
            "type":"string",
            "maxLength":15
        },
        "TransactionKey":{
            "description":"The unique identifier of the transaction.",
            "type":"integer",
            "format":"int64"
        },
        "TransactionType":{
            "description":"The type of transaction.",
            "type":"string",
            "maxLength":15
        },
        "WorkflowAction":{
            "description":"The action to be performed on the associated dynamic workflow instance.",
            "type":"string"
        },
        "WorkflowActivityPayload":{
            "description":"The additional payload to be sent to the associated dynamic workflow instance.",
            "type":"string"
        },
        "WorkflowPayload":{
            "description":"The payload to be sent to the associated dynamic workflow instance.",
            "type":"string"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top