Get all processes
get
/fscmRestApi/resources/11.13.18.05/frcProcesses
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the process assigned a specified primary key.
Finder Variables:- ProcessId; integer; The unique identifier of the process.
- PrimaryKey: Finds the process assigned a specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ApprovedBy; string; The user who approved the process.
- ApprovedDate; string; The date and time the process was approved.
- AssessmentFlag; boolean; Identifies if the process is in scope for an assessment.
- AuditTestingFlag; boolean; Identifies if the process is in scope for audit testing.
- CreatedBy; string; The user who created the process.
- CreationDate; string; The date and time the process was created.
- DetailedDescription; string; The description of the process.
- LastUpdateDate; string; The date and time the process was most recently updated.
- LastUpdatedBy; string; The user who most recently updated the process.
- Name; string; The name of the process.
- ProcessId; integer; The unique identifier of the process.
- ReviewStartDate; string; The date and time when the process review was started.
- ReviewedBy; string; The user who reviewed the process.
- ReviewedDate; string; The date and time the process was reviewed.
- RevisionDate; string; The date when the process was revised.
- RevisionNumber; integer; The revision of the process.
- StateCode; string; The state of the process.
- Status; string; The status of the process: ACTIVE or INACTIVE.
- TotalRevisions; integer; The total number of revisions for the process.
- Type; string; One in a set of user-defined values that may be selected for the process.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : frcProcesses
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : frcProcesses-item-response
Type:
Show Source
object
-
actionItems: array
Action Items
Title:
Action Items
The action items resource is used to view or modify action items to be completed in conjunction with processes. -
additionalInformation: array
Flexfields
Title:
Flexfields
The flexfields resource is used to view or modify information added to process definitions in flexfields. -
ApprovedBy: string
Title:
Last Approved By
Read Only:true
Maximum Length:64
The user who approved the process. -
ApprovedDate: string
(date-time)
Title:
Approved Date
Read Only:true
The date and time the process was approved. -
AssessmentFlag: boolean
Title:
Assessment Testing
Maximum Length:1
Default Value:false
Identifies if the process is in scope for an assessment. -
AuditTestingFlag: boolean
Title:
Audit Testing
Maximum Length:1
Default Value:false
Identifies if the process is in scope for audit testing. -
comments: array
Comments
Title:
Comments
The comments resource is used to view or modify comments written about processes. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the process. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the process was created. -
DetailedDescription: string
(byte)
Title:
Description
The description of the process. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the process was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who most recently updated the process. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:150
The name of the process. -
perspectives: array
Perspectives
Title:
Perspectives
The perspectives resource is used to view perspective values assigned to processes or to modify those assignments. -
ProcessId: integer
(int64)
Title:
Record ID
Read Only:true
The unique identifier of the process. - relatedRisks: array Related Risks
-
ReviewedBy: string
Title:
Last Reviewed By
Read Only:true
Maximum Length:64
The user who reviewed the process. -
ReviewedDate: string
(date-time)
Title:
Reviewed Date
Read Only:true
The date and time the process was reviewed. -
ReviewStartDate: string
(date-time)
Title:
Reviewed Date
Read Only:true
The date and time when the process review was started. -
RevisionDate: string
(date-time)
Title:
Revision Date
Read Only:true
The date when the process was revised. -
RevisionNumber: integer
(int32)
Title:
Revision Number
Read Only:true
Default Value:1
The revision of the process. -
StateCode: string
Title:
State
Read Only:true
Maximum Length:30
Default Value:NEW
The state of the process. -
Status: string
Title:
Status
Maximum Length:30
Default Value:ACTIVE
The status of the process: ACTIVE or INACTIVE. -
TotalRevisions: integer
(int32)
Read Only:
true
The total number of revisions for the process. -
Type: string
Title:
Type
Maximum Length:30
One in a set of user-defined values that may be selected for the process.
Nested Schema : Action Items
Type:
array
Title:
Action Items
The action items resource is used to view or modify action items to be completed in conjunction with processes.
Show Source
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The flexfields resource is used to view or modify information added to process definitions in flexfields.
Show Source
Nested Schema : Comments
Type:
array
Title:
Comments
The comments resource is used to view or modify comments written about processes.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Perspectives
Type:
array
Title:
Perspectives
The perspectives resource is used to view perspective values assigned to processes or to modify those assignments.
Show Source
Nested Schema : frcProcesses-actionItems-item-response
Type:
Show Source
object
-
ActionId: integer
(int64)
Title:
Record ID
The unique identifier of the action item. -
CompletedDate: string
(date)
Title:
Completion Date
The date and time the action item was marked as complete. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the action item. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the action item was created. -
DetailedDescription: string
(byte)
Title:
Instructions
The description of the action item. This is a CLOB attribute. -
DueDate: string
(date-time)
Title:
Due Date
The date when the action item is due. -
EstimatedCompletionDate: string
(date-time)
Title:
Target Completion Date
The target completion date of the action item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the action item was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who most recently updated the action item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:150
The name of the action item. -
PriorityCode: string
Title:
Priority
Maximum Length:30
The priority of the action item. -
ProcessId: integer
(int64)
The unique identifier of the process the action item is related to.
-
ProgressCode: string
Title:
Progress
Maximum Length:30
A value indicating progress toward completion of the action item: Assigned, Blocked, Delayed, or On Target. -
StartDate: string
(date-time)
Title:
Start Date
Read Only:true
The date when the action item started. -
StateCode: string
Title:
State
Read Only:true
Maximum Length:30
Default Value:ACTIVE
The state of the action item.
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.
Nested Schema : frcProcesses-additionalInformation-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
The context of the flexfields associated to the process. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The display value of the context of the flexfields associated to the process. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessId: integer
(int64)
Title:
Record ID
The unique identifier of the process associated to the flexfield.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : frcProcesses-comments-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the comment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the comment was created. -
Id: integer
The unique identifier of the comment on the process.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UserComment: string
Title:
Comment
Maximum Length:2000
The comment made on the process.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : frcProcesses-perspectives-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:150
The name of the perspective item assigned to the process. -
PerspItemId: integer
(int64)
The unique identifier of the perspective value assigned to the process.
-
ProcessId: integer
(int64)
The unique identifier of the process.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve all the processes by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "ApprovedBy": null, "ApprovedDate": null, "AssessmentFlag": true, "AuditTestingFlag": true, "CreatedBy": "FRC_ADMIN_AP_2", "CreationDate": "2019-04-22T11:02:01+00:00", "LastUpdateDate": "2019-04-22T13:49:39+00:00", "LastUpdatedBy": "FRC_ADMIN_AP_1", "Name": "Test_Overview_AP_2", "ProcessId": 11020, "ReviewStartDate": null, "ReviewedBy": "FRC_ADMIN_AP_1", "ReviewedDate": "2019-04-22T13:50:09.023+00:00", "RevisionDate": "2019-04-22T11:02:34.864+00:00", "RevisionNumber": 1, "StateCode": "APPROVE", "Status": "ACTIVE", "TotalRevisions": 1, "Type": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020", "name": "frcProcesses", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020", "name": "frcProcesses", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020/lov/FRCLookupsAM_ProcessState", "name": "FRCLookupsAM_ProcessState", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020/lov/FRCLookupsAM_BusinessEntityStatus", "name": "FRCLookupsAM_BusinessEntityStatus", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020/lov/FRCLookupsAM_ProcessType", "name": "FRCLookupsAM_ProcessType", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020/child/actionItems", "name": "actionItems", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020/child/additionalInformation", "name": "additionalInformation", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020/child/comments", "name": "comments", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020/child/perspectives", "name": "perspectives", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020/child/relatedRisks", "name": "relatedRisks", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/11020/enclosure/DetailedDescription", "name": "DetailedDescription", "kind": "other" } ] }, ... ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses", "name": "frcProcesses", "kind": "collection" } ] }