Update a process
patch
/fscmRestApi/resources/11.13.18.05/frcProcesses/{ProcessId}
Request
Path Parameters
-
ProcessId(required): integer(int64)
The unique identifier of the process.
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
Root Schema : schema
Type:
Show Source
object
-
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. -
Name: string
Title:
Name
Maximum Length:150
The name of the process. -
Status: string
Title:
Status
Maximum Length:30
Default Value:ACTIVE
The status of the process: ACTIVE or INACTIVE. -
Type: string
Title:
Type
Maximum Length:30
One in a set of user-defined values that may be selected for the process.
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.
Root 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
Links
- actionItems
-
Parameters:
- ProcessId:
$request.path.ProcessId
The action items resource is used to view or modify action items to be completed in conjunction with processes. - ProcessId:
- additionalInformation
-
Parameters:
- ProcessId:
$request.path.ProcessId
The flexfields resource is used to view or modify information added to process definitions in flexfields. - ProcessId:
- comments
-
Parameters:
- ProcessId:
$request.path.ProcessId
The comments resource is used to view or modify comments written about processes. - ProcessId:
- perspectives
-
Parameters:
- ProcessId:
$request.path.ProcessId
The perspectives resource is used to view perspective values assigned to processes or to modify those assignments. - ProcessId:
- relatedRisks
-
Parameters:
- ProcessId:
$request.path.ProcessId
The related risks resource is used to view records of risks that may impact processes. - ProcessId:
Examples
The following example shows how to update a process by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "Name": "Process Renamed" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "ApprovedBy": null, "ApprovedDate": null, "AssessmentFlag": false, "AuditTestingFlag": false, "CreatedBy": "FRC_WSUSER", "CreationDate": "2021-01-06T16:44:54+00:00", "LastUpdateDate": "2021-01-06T17:09:53.007+00:00", "LastUpdatedBy": "FRC_WSUSER", "Name": "Process Renamed", "ProcessId": 43019, "ReviewStartDate": null, "ReviewedBy": null, "ReviewedDate": null, "RevisionDate": "2021-01-06T16:44:54.460+00:00", "RevisionNumber": 1, "StateCode": "NEW", "Status": "ACTIVE", "TotalRevisions": 1, "Type": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019", "name": "frcProcesses", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019", "name": "frcProcesses", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/child/actionItems", "name": "actionItems", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/child/additionalInformation", "name": "additionalInformation", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/child/comments", "name": "comments", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/child/perspectives", "name": "perspectives", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/child/relatedRisks", "name": "relatedRisks", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/enclosure/DetailedDescription", "name": "DetailedDescription", "kind": "other" } ] }