Get a process group
get
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowProcessGroups/{publicSectorWorkflowProcessGroupsUniqID}
Request
Path Parameters
-
publicSectorWorkflowProcessGroupsUniqID: integer
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 attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorWorkflowProcessGroups-item
Type:
Show Source
object
-
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.
Nested Schema : link
Type:
Show Source
object
-
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.