Get a process group
get
/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>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : publicSectorWorkflowProcessGroups-item-response
Type:
Show Source
object
-
AdhocNoticeStFlag: string
Title:
Ad Hoc Notice Status Update
Maximum Length:1
Default Value:N
Indicates the ad hoc notice status of a case. The default value is N, indicating not active. -
AgencyId: integer
(int32)
The unique identifier for the agency.
-
CaseStFlag: string
Title:
Case Functional Status Update
Maximum Length:1
Default Value:N
Indicates the functional status of the case. The default value is N, indicating not active. -
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. -
ProcessActiveFlag: string
Maximum Length:
1
Default Value:N
Indicates if there is an active transaction linked with the process definition. The default value is N. -
ProcessGrpId: string
Title:
Group ID
Maximum Length:50
The unique identifier for the process group. -
SystemNoticeStFlag: string
Title:
System Notice Status Update
Maximum Length:1
Default Value:N
Indicates the system notice status of a case. The default value is N, indicating not active.
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.