Jump to

• Request
• Response

Update a process group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowProcessGroups/{publicSectorWorkflowProcessGroupsUniqID}

Request

Path Parameters

• publicSectorWorkflowProcessGroupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ProcessGrpId and AgencyId ---for the Process Definition Groups resource and used to uniquely identify an instance of Process Definition Groups. The client should not generate the hash key value. Instead, the client should query on the Process Definition Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Process Definition Groups.
  
  For example: publicSectorWorkflowProcessGroups?q=ProcessGrpId=<value1>;AgencyId=<value2>

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.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• CsGlobalTaskId: string
  Title: Global Task ID

  Maximum Length: 500

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

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

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

  Maximum Length: 500

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

  Maximum Length: 300

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

  Maximum Length: 50

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

  Maximum Length: 500

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

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

  Maximum Length: 1000

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

  Maximum Length: 300

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

  Maximum Length: 1

  Default Value: 'N'

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

  Maximum Length: 500

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

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

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

  Maximum Length: 500

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

  Maximum Length: 300

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

  Maximum Length: 50

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

  Maximum Length: 500

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

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

  Maximum Length: 1000

  The project space name for incident object.

{
    "type":"object",
    "properties":{
        "CsProcessDefId":{
            "title":"Process Definition ID",
            "maxLength":500,
            "type":"string",
            "description":"The process definition id for case object.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of process group.",
            "nullable":true
        },
        "CsPrcsCategory":{
            "maxLength":1000,
            "type":"string",
            "description":"The process category for case object.",
            "nullable":true
        },
        "IncProcessVersion":{
            "title":"Version",
            "maxLength":50,
            "type":"string",
            "description":"The process version for incident object.",
            "nullable":true
        },
        "CsSpaceId":{
            "maxLength":500,
            "type":"string",
            "description":"The project space id for case object.",
            "nullable":true
        },
        "IncPrcsCategory":{
            "maxLength":1000,
            "type":"string",
            "description":"The process category for incident object.",
            "nullable":true
        },
        "IncGlobalTaskId":{
            "title":"Global Task ID",
            "maxLength":500,
            "type":"string",
            "description":"The global task id for incident object.",
            "nullable":true
        },
        "CsSpaceName":{
            "title":"Space",
            "maxLength":1000,
            "type":"string",
            "description":"The project space name for case object.",
            "nullable":true
        },
        "IncProcessDefId":{
            "title":"Process Definition ID",
            "maxLength":500,
            "type":"string",
            "description":"The process definition id for incident object.",
            "nullable":true
        },
        "CsProcessVersion":{
            "title":"Version",
            "maxLength":50,
            "type":"string",
            "description":"The process version for case object.",
            "nullable":true
        },
        "CsProjectId":{
            "title":"Application",
            "maxLength":500,
            "type":"string",
            "description":"The project identifier for case object.",
            "nullable":true
        },
        "CsGlobalTaskName":{
            "maxLength":1000,
            "type":"string",
            "description":"The global task name for case object.",
            "nullable":true
        },
        "CsProcessDefKey":{
            "title":"Process Definition",
            "maxLength":300,
            "type":"string",
            "description":"The process definition key for case object.",
            "nullable":true
        },
        "IncSpaceName":{
            "title":"Space",
            "maxLength":1000,
            "type":"string",
            "description":"The project space name for incident object.",
            "nullable":true
        },
        "IncProcessDefKey":{
            "title":"Process Definition",
            "maxLength":300,
            "type":"string",
            "description":"The process definition key for incident object.",
            "nullable":true
        },
        "IncSpaceId":{
            "maxLength":500,
            "type":"string",
            "description":"The project space id for incident object.",
            "nullable":true
        },
        "IncProjectId":{
            "title":"Application",
            "maxLength":500,
            "type":"string",
            "description":"The project identifier for incident object.",
            "nullable":true
        },
        "CsGlobalTaskId":{
            "title":"Global Task ID",
            "maxLength":500,
            "type":"string",
            "description":"The global task id for case object.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"To enable a process group.",
            "nullable":false,
            "default":"'N'"
        },
        "IncGlobalTaskName":{
            "maxLength":1000,
            "type":"string",
            "description":"The global task name for incident object.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorWorkflowProcessGroups-item-response

Type: object

Show Source

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

  Maximum Length: 500

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

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

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

  Maximum Length: 500

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

  Maximum Length: 300

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

  Maximum Length: 50

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

  Maximum Length: 500

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

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

  Maximum Length: 1000

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

  Maximum Length: 300

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

  Maximum Length: 1

  Default Value: 'N'

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

  Maximum Length: 500

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

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

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

  Maximum Length: 500

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

  Maximum Length: 300

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

  Maximum Length: 50

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

  Maximum Length: 500

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

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

  Maximum Length: 1000

  The project space name for incident object.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessGrpId: string
  Title: Group ID

  Maximum Length: 50

  The unique identifier for the process group.

{
    "type":"object",
    "properties":{
        "CsProcessDefId":{
            "title":"Process Definition ID",
            "maxLength":500,
            "type":"string",
            "description":"The process definition id for case object.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of process group.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CsPrcsCategory":{
            "maxLength":1000,
            "type":"string",
            "description":"The process category for case object.",
            "nullable":true,
            "x-queryable":true
        },
        "IncProcessVersion":{
            "title":"Version",
            "maxLength":50,
            "type":"string",
            "description":"The process version for incident object.",
            "nullable":true,
            "x-queryable":true
        },
        "CsSpaceId":{
            "maxLength":500,
            "type":"string",
            "description":"The project space id for case object.",
            "nullable":true,
            "x-queryable":true
        },
        "IncPrcsCategory":{
            "maxLength":1000,
            "type":"string",
            "description":"The process category for incident object.",
            "nullable":true,
            "x-queryable":true
        },
        "IncGlobalTaskId":{
            "title":"Global Task ID",
            "maxLength":500,
            "type":"string",
            "description":"The global task id for incident object.",
            "nullable":true,
            "x-queryable":true
        },
        "CsSpaceName":{
            "title":"Space",
            "maxLength":1000,
            "type":"string",
            "description":"The project space name for case object.",
            "nullable":true,
            "x-queryable":true
        },
        "IncProcessDefId":{
            "title":"Process Definition ID",
            "maxLength":500,
            "type":"string",
            "description":"The process definition id for incident object.",
            "nullable":true,
            "x-queryable":true
        },
        "CsProcessVersion":{
            "title":"Version",
            "maxLength":50,
            "type":"string",
            "description":"The process version for case object.",
            "nullable":true,
            "x-queryable":true
        },
        "CsProjectId":{
            "title":"Application",
            "maxLength":500,
            "type":"string",
            "description":"The project identifier for case object.",
            "nullable":true,
            "x-queryable":true
        },
        "CsGlobalTaskName":{
            "maxLength":1000,
            "type":"string",
            "description":"The global task name for case object.",
            "nullable":true,
            "x-queryable":true
        },
        "CsProcessDefKey":{
            "title":"Process Definition",
            "maxLength":300,
            "type":"string",
            "description":"The process definition key for case object.",
            "nullable":true,
            "x-queryable":true
        },
        "IncSpaceName":{
            "title":"Space",
            "maxLength":1000,
            "type":"string",
            "description":"The project space name for incident object.",
            "nullable":true,
            "x-queryable":true
        },
        "IncProcessDefKey":{
            "title":"Process Definition",
            "maxLength":300,
            "type":"string",
            "description":"The process definition key for incident object.",
            "nullable":true,
            "x-queryable":true
        },
        "IncSpaceId":{
            "maxLength":500,
            "type":"string",
            "description":"The project space id for incident object.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessGrpId":{
            "title":"Group ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the process group.",
            "nullable":false,
            "x-queryable":true
        },
        "IncProjectId":{
            "title":"Application",
            "maxLength":500,
            "type":"string",
            "description":"The project identifier for incident object.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CsGlobalTaskId":{
            "title":"Global Task ID",
            "maxLength":500,
            "type":"string",
            "description":"The global task id for case object.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"To enable a process group.",
            "nullable":false,
            "default":"'N'",
            "x-queryable":true
        },
        "IncGlobalTaskName":{
            "maxLength":1000,
            "type":"string",
            "description":"The global task name for incident object.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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