Update one compliance checklist record
patch
/fscmRestApi/resources/11.13.18.05/complianceChecklists/{complianceChecklistsUniqID}
Request
Path Parameters
-
complianceChecklistsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Compliance Checklists resource and used to uniquely identify an instance of Compliance Checklists. The client should not generate the hash key value. Instead, the client should query on the Compliance Checklists collection resource in order to navigate to a specific instance of Compliance Checklists to get the hash key.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
-
CanceledReason: string
Title:
Canceled Reason
Maximum Length:1000
Reason for the compliance checklist cancellation. -
ChecklistOwner: string
Title:
Checklist Owner
Maximum Length:240
Owner of the compliance checklist. -
ChecklistOwnerId: integer
(int64)
Identifier of the compliance checklist owner.
-
ReopenReason: string
Title:
Reopening Reason
Maximum Length:1000
Reason for reopening the compliance checklist. -
Status: string
Title:
Status
Maximum Length:80
Status of the compliance checklist. -
StatusCode: string
Maximum Length:
30
Code of the compliance checklist status. -
Title: string
Maximum Length:
80
Title of the compliance checklist.
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 : complianceChecklists-item-response
Type:
Show Source
object
-
CanceledBy: string
Title:
Canceled By
Read Only:true
Maximum Length:240
Name of the user who canceled the compliance checklist. -
CanceledById: integer
(int64)
Read Only:
true
Identifier of the user who canceled the compliance checklist. -
CanceledReason: string
Title:
Canceled Reason
Maximum Length:1000
Reason for the compliance checklist cancellation. -
CancellationDate: string
(date-time)
Title:
Canceled On
Read Only:true
Date of the compliance checklist cancellation. -
Checklist: string
Maximum Length:
30
Value that uniquely identifies the compliance checklist. -
ChecklistInitiativeId: integer
(int64)
System identifier of the compliance checklist. The identifier is stored as an initiative ID.
-
ChecklistOwner: string
Title:
Checklist Owner
Maximum Length:240
Owner of the compliance checklist. -
ChecklistOwnerId: integer
(int64)
Identifier of the compliance checklist owner.
-
ChecklistTemplate: string
Maximum Length:
80
Checklist template used to create the compliance checklist. -
ChecklistTemplateId: integer
(int64)
System identifier of the checklist template used to create the compliance checklist.
-
ChecklistTemplateRevision: integer
(int32)
Read Only:
true
Revision of the checklist template used to create the compliance checklist. -
CompletedBy: string
Title:
Completed By
Read Only:true
Maximum Length:240
Name of the user who completed the compliance checklist. -
CompletedById: integer
(int64)
Read Only:
true
Identifier of the user who completed the compliance checklist. -
CompletionDate: string
(date-time)
Title:
Completed On
Read Only:true
Date of the compliance checklist completion. -
CreationDate: string
(date-time)
Title:
Created On
Read Only:true
Date and time when the checklist was created. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
POHeaderId: integer
Read Only:
true
System identifier of the purchasing document associated with the compliance checklist. -
PONumber: string
Read Only:
true
Maximum Length:80
Value that uniquely identifies the purchasing document associated with the compliance checklist. -
POStatus: string
Read Only:
true
Maximum Length:80
Status of the purchasing document associated with the compliance checklist. -
ProcurementBU: string
Title:
Procurement BU
Maximum Length:240
Procurement business unit where the compliance checklist was created. -
ProcurementBUId: integer
(int64)
Business unit identifier of the procurement business unit where the compliance checklist was created.
-
PurchasingDocumentType: string
Read Only:
true
Maximum Length:80
Type of the purchasing document associated with the compliance checklist. -
ReopenDate: string
(date-time)
Title:
Reopened On
Read Only:true
Date the compliance checklist was reopened. -
ReopenedBy: string
Title:
Reopened By
Read Only:true
Maximum Length:240
Name of the user who reopened the compliance checklist. -
ReopenedById: integer
(int64)
Read Only:
true
Identifier of the user who reopened the compliance checklist. -
ReopenReason: string
Title:
Reopening Reason
Maximum Length:1000
Reason for reopening the compliance checklist. -
Status: string
Title:
Status
Maximum Length:80
Status of the compliance checklist. -
StatusCode: string
Maximum Length:
30
Code of the compliance checklist status. -
Title: string
Maximum Length:
80
Title of the compliance checklist.
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.
Examples
This example describes how to update one compliance checklist.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/complianceChecklists/ChecklistInitiativeId"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "Title": "Updated Demo Checklist Oct 30" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ChecklistInitiativeId": 300100584890682, "Checklist": "Checklist-112", "Title": "Updated Demo Checklist Oct 30", "StatusCode": "ORA_DRAFT", "Status": "Draft", "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "ChecklistOwnerId": 100010026863783, "ChecklistOwner": "Furey,Clare", "ChecklistTemplateId": 300100584218626, "ChecklistTemplate": "Direct Materials", "ChecklistTemplateRevision": 2, "ReopenDate": null, "ReopenedById": null, "ReopenedBy": null, "ReopenReason": null, "CompletionDate": null, "CompletedById": null, "CompletedBy": null, "CancellationDate": null, "CanceledById": null, "CanceledBy": null, "CanceledReason": null, "CreationDate": "2023-10-30T17:59:51+00:00", "POHeaderId": null, "PONumber": null, "POStatus": null, "PurchasingDocumentType": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/complianceChecklists/300100584890682", "name": "complianceChecklists", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/complianceChecklists/300100584890682", "name": "complianceChecklists", "kind": "item" } ] }