Jump to

• Request
• Response

Create process groups

post

/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowProcessGroups

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 : publicSectorWorkflowProcessGroups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier for the agency.
• CsGlobalTaskId(optional): string
  Title: Global Task ID

  Maximum Length: 500

  The global task id for case object.
• CsGlobalTaskName(optional): string
  Maximum Length: 1000

  The global task name for case object.
• CsPrcsCategory(optional): string
  Maximum Length: 1000

  The process category for case object.
• CsProcessDefId(optional): string
  Title: Process Definition ID

  Maximum Length: 500

  The process definition id for case object.
• CsProcessDefKey(optional): string
  Title: Process Definition

  Maximum Length: 300

  The process definition key for case object.
• CsProcessVersion(optional): string
  Title: Version

  Maximum Length: 50

  The process version for case object.
• CsProjectId(optional): string
  Title: Application

  Maximum Length: 500

  The project identifier for case object.
• CsSpaceId(optional): string
  Maximum Length: 500

  The project space id for case object.
• CsSpaceName(optional): string
  Title: Space

  Maximum Length: 1000

  The project space name for case object.
• Description(optional): string
  Title: Description

  Maximum Length: 300

  The description of process group.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  To enable a process group.
• IncGlobalTaskId(optional): string
  Title: Global Task ID

  Maximum Length: 500

  The global task id for incident object.
• IncGlobalTaskName(optional): string
  Maximum Length: 1000

  The global task name for incident object.
• IncPrcsCategory(optional): string
  Maximum Length: 1000

  The process category for incident object.
• IncProcessDefId(optional): string
  Title: Process Definition ID

  Maximum Length: 500

  The process definition id for incident object.
• IncProcessDefKey(optional): string
  Title: Process Definition

  Maximum Length: 300

  The process definition key for incident object.
• IncProcessVersion(optional): string
  Title: Version

  Maximum Length: 50

  The process version for incident object.
• IncProjectId(optional): string
  Title: Application

  Maximum Length: 500

  The project identifier for incident object.
• IncSpaceId(optional): string
  Maximum Length: 500

  The project space id for incident object.
• IncSpaceName(optional): string
  Title: Space

  Maximum Length: 1000

  The project space name for incident object.
• links(optional): array Items
  Title: Items

  Link Relations
• ProcessGrpId(optional): string
  Title: Group ID

  Maximum Length: 50

  The unique identifier for the process group.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency."
        },
        "CsGlobalTaskId":{
            "maxLength":500,
            "type":"string",
            "description":"The global task id for case object.",
            "title":"Global Task ID"
        },
        "CsGlobalTaskName":{
            "maxLength":1000,
            "type":"string",
            "description":"The global task name for case object."
        },
        "CsPrcsCategory":{
            "maxLength":1000,
            "type":"string",
            "description":"The process category for case object."
        },
        "CsProcessDefId":{
            "maxLength":500,
            "type":"string",
            "description":"The process definition id for case object.",
            "title":"Process Definition ID"
        },
        "CsProcessDefKey":{
            "maxLength":300,
            "type":"string",
            "description":"The process definition key for case object.",
            "title":"Process Definition"
        },
        "CsProcessVersion":{
            "maxLength":50,
            "type":"string",
            "description":"The process version for case object.",
            "title":"Version"
        },
        "CsProjectId":{
            "maxLength":500,
            "type":"string",
            "description":"The project identifier for case object.",
            "title":"Application"
        },
        "CsSpaceId":{
            "maxLength":500,
            "type":"string",
            "description":"The project space id for case object."
        },
        "CsSpaceName":{
            "maxLength":1000,
            "type":"string",
            "description":"The project space name for case object.",
            "title":"Space"
        },
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"The description of process group.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"To enable a process group.",
            "title":"Enabled"
        },
        "IncGlobalTaskId":{
            "maxLength":500,
            "type":"string",
            "description":"The global task id for incident object.",
            "title":"Global Task ID"
        },
        "IncGlobalTaskName":{
            "maxLength":1000,
            "type":"string",
            "description":"The global task name for incident object."
        },
        "IncPrcsCategory":{
            "maxLength":1000,
            "type":"string",
            "description":"The process category for incident object."
        },
        "IncProcessDefId":{
            "maxLength":500,
            "type":"string",
            "description":"The process definition id for incident object.",
            "title":"Process Definition ID"
        },
        "IncProcessDefKey":{
            "maxLength":300,
            "type":"string",
            "description":"The process definition key for incident object.",
            "title":"Process Definition"
        },
        "IncProcessVersion":{
            "maxLength":50,
            "type":"string",
            "description":"The process version for incident object.",
            "title":"Version"
        },
        "IncProjectId":{
            "maxLength":500,
            "type":"string",
            "description":"The project identifier for incident object.",
            "title":"Application"
        },
        "IncSpaceId":{
            "maxLength":500,
            "type":"string",
            "description":"The project space id for incident object."
        },
        "IncSpaceName":{
            "maxLength":1000,
            "type":"string",
            "description":"The project space name for incident object.",
            "title":"Space"
        },
        "ProcessGrpId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the process group.",
            "title":"Group ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorWorkflowProcessGroups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier for the agency.
• CsGlobalTaskId(optional): string
  Title: Global Task ID

  Maximum Length: 500

  The global task id for case object.
• CsGlobalTaskName(optional): string
  Maximum Length: 1000

  The global task name for case object.
• CsPrcsCategory(optional): string
  Maximum Length: 1000

  The process category for case object.
• CsProcessDefId(optional): string
  Title: Process Definition ID

  Maximum Length: 500

  The process definition id for case object.
• CsProcessDefKey(optional): string
  Title: Process Definition

  Maximum Length: 300

  The process definition key for case object.
• CsProcessVersion(optional): string
  Title: Version

  Maximum Length: 50

  The process version for case object.
• CsProjectId(optional): string
  Title: Application

  Maximum Length: 500

  The project identifier for case object.
• CsSpaceId(optional): string
  Maximum Length: 500

  The project space id for case object.
• CsSpaceName(optional): string
  Title: Space

  Maximum Length: 1000

  The project space name for case object.
• Description(optional): string
  Title: Description

  Maximum Length: 300

  The description of process group.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  To enable a process group.
• IncGlobalTaskId(optional): string
  Title: Global Task ID

  Maximum Length: 500

  The global task id for incident object.
• IncGlobalTaskName(optional): string
  Maximum Length: 1000

  The global task name for incident object.
• IncPrcsCategory(optional): string
  Maximum Length: 1000

  The process category for incident object.
• IncProcessDefId(optional): string
  Title: Process Definition ID

  Maximum Length: 500

  The process definition id for incident object.
• IncProcessDefKey(optional): string
  Title: Process Definition

  Maximum Length: 300

  The process definition key for incident object.
• IncProcessVersion(optional): string
  Title: Version

  Maximum Length: 50

  The process version for incident object.
• IncProjectId(optional): string
  Title: Application

  Maximum Length: 500

  The project identifier for incident object.
• IncSpaceId(optional): string
  Maximum Length: 500

  The project space id for incident object.
• IncSpaceName(optional): string
  Title: Space

  Maximum Length: 1000

  The project space name for incident object.
• links(optional): array Items
  Title: Items

  Link Relations
• ProcessGrpId(optional): string
  Title: Group ID

  Maximum Length: 50

  The unique identifier for the process group.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency."
        },
        "CsGlobalTaskId":{
            "maxLength":500,
            "type":"string",
            "description":"The global task id for case object.",
            "title":"Global Task ID"
        },
        "CsGlobalTaskName":{
            "maxLength":1000,
            "type":"string",
            "description":"The global task name for case object."
        },
        "CsPrcsCategory":{
            "maxLength":1000,
            "type":"string",
            "description":"The process category for case object."
        },
        "CsProcessDefId":{
            "maxLength":500,
            "type":"string",
            "description":"The process definition id for case object.",
            "title":"Process Definition ID"
        },
        "CsProcessDefKey":{
            "maxLength":300,
            "type":"string",
            "description":"The process definition key for case object.",
            "title":"Process Definition"
        },
        "CsProcessVersion":{
            "maxLength":50,
            "type":"string",
            "description":"The process version for case object.",
            "title":"Version"
        },
        "CsProjectId":{
            "maxLength":500,
            "type":"string",
            "description":"The project identifier for case object.",
            "title":"Application"
        },
        "CsSpaceId":{
            "maxLength":500,
            "type":"string",
            "description":"The project space id for case object."
        },
        "CsSpaceName":{
            "maxLength":1000,
            "type":"string",
            "description":"The project space name for case object.",
            "title":"Space"
        },
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"The description of process group.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"To enable a process group.",
            "title":"Enabled"
        },
        "IncGlobalTaskId":{
            "maxLength":500,
            "type":"string",
            "description":"The global task id for incident object.",
            "title":"Global Task ID"
        },
        "IncGlobalTaskName":{
            "maxLength":1000,
            "type":"string",
            "description":"The global task name for incident object."
        },
        "IncPrcsCategory":{
            "maxLength":1000,
            "type":"string",
            "description":"The process category for incident object."
        },
        "IncProcessDefId":{
            "maxLength":500,
            "type":"string",
            "description":"The process definition id for incident object.",
            "title":"Process Definition ID"
        },
        "IncProcessDefKey":{
            "maxLength":300,
            "type":"string",
            "description":"The process definition key for incident object.",
            "title":"Process Definition"
        },
        "IncProcessVersion":{
            "maxLength":50,
            "type":"string",
            "description":"The process version for incident object.",
            "title":"Version"
        },
        "IncProjectId":{
            "maxLength":500,
            "type":"string",
            "description":"The project identifier for incident object.",
            "title":"Application"
        },
        "IncSpaceId":{
            "maxLength":500,
            "type":"string",
            "description":"The project space id for incident object."
        },
        "IncSpaceName":{
            "maxLength":1000,
            "type":"string",
            "description":"The project space name for incident object.",
            "title":"Space"
        },
        "ProcessGrpId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the process group.",
            "title":"Group ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top