Update one application partner document
patch
/fscmRestApi/resources/11.13.18.05/b2bApplicationPartners/{ApplicationPartnerId}/child/documents/{ApplicationPartnerDocumentId}
Request
Path Parameters
-
ApplicationPartnerDocumentId(required): integer(int64)
Value that uniquely identifies one of the application partner's documents. It is a primary key that the application generates when it creates a application partner document record. This attribute is required.
-
ApplicationPartnerId(required): integer(int64)
Value that uniquely identifies the application partner. It is a primary key that the application generates when it creates a application partner record. This attribute is required.
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
-
ApplicationPartnerDocumentStatus: string
Maximum Length:
100
Value that indicates an application partner document status. Valid values include Enabled, Disabled, and Hold for inbound document. The default value is Disabled. -
Direction: string
Value that identifies the direction.
-
DocumentDescription: string
Value that identifies the collaboration document description.
-
PrimaryRecipientFlag: boolean
Maximum Length:
1
Value that identifies the primary recipient document. -
SenderRole: string
Value that identifies the sender role.
-
ServiceProviderId: integer
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.
-
StatusDate: string
(date-time)
Date when the application partner document was created or updated.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : b2bApplicationPartners-documents-item-response
Type:
Show Source
object
-
ApplicationPartnerDocumentId: integer
(int64)
Value that uniquely identifies one of the application partner's documents. It is a primary key that the application generates when it creates a application partner document record. This attribute is required.
-
ApplicationPartnerDocumentStatus: string
Maximum Length:
100
Value that indicates an application partner document status. Valid values include Enabled, Disabled, and Hold for inbound document. The default value is Disabled. -
Direction: string
Value that identifies the direction.
-
DocumentDescription: string
Value that identifies the collaboration document description.
-
DocumentId: integer
(int64)
Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
-
DocumentName: string
Value that identifies the collaboration document name.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryRecipientFlag: boolean
Maximum Length:
1
Value that identifies the primary recipient document. -
SenderRole: string
Value that identifies the sender role.
-
ServiceProviderId: integer
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.
-
StatusDate: string
(date-time)
Date when the application partner document was created or updated.
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 application partner document.
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/b2bApplicationPartners/ApplicationPartnerId/child/documents/ApplicationPartnerDocumentId"
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.
{ "ApplicationPartnerDocumentStatus": "Disabled" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ApplicationPartnerDocumentStatus": "Disabled", "DocumentId": 50011, "ApplicationPartnerDocumentId": 300100186138552, "StatusDate": "2019-08-29T13:14:40.043+00:00", "PrimaryRecipientFlag": true, "DocumentName": "PROCESS_PO_IN", "SenderRole": "Customer", "Direction": "In", "ServiceProviderId": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186137263/child/documents/300100186138552", "name": "documents", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186137263/child/documents/300100186138552", "name": "documents", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/b2bApplicationPartners/300100186137263", "name": "b2bApplicationPartners", "kind": "item" } ] }