Create related documents
post
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RelatedDocument
Request
Path Parameters
-
contractsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.
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
-
Attribute26: string
Maximum Length:
150
The attribute26. -
ChrId: integer
(int64)
The contract ID
-
CleId: integer
(int64)
The contract line ID
-
ContractNumber: string
Title:
Document Reference
Maximum Length:120
Related Contract Number -
CreateEnableFlag: boolean
The create enable flag.
-
DeleteEnableFlag: boolean
The delete enable flag.
-
DocumentTypeNew: string
Title:
Document Type
The document type new. -
ExternalKey: string
Maximum Length:
120
External Key -
ExternalSource: string
Maximum Length:
120
External Source -
Id: integer
(int64)
Related Document ID
-
IntentMeaning: string
Title:
Intent
Maximum Length:80
The intent. -
JtotObject1Code: string
Maximum Length:
30
Default Value:OKX_ECMCONTRACT
The jtot object1 code. -
RelatedContractId: integer
(int64)
Title:
Document Reference
Related Contract ID -
RelatedObjPuid: string
Title:
Related Object PUID
Maximum Length:120
The related obj PUID. -
Relationship: string
Relationship name
-
RelationshipCode: string
Title:
Relationship
Maximum Length:30
Relationship Code
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 : contracts-RelatedDocument-item-response
Type:
Show Source
object
-
Attribute26: string
Maximum Length:
150
The attribute26. -
BuyOrSell: string
Title:
Intent
Read Only:true
Maximum Length:3
The intent flag. -
ChrId: integer
(int64)
The contract ID
-
CleId: integer
(int64)
The contract line ID
-
Cognomen: string
Title:
Name
Read Only:true
Maximum Length:300
The contract name. -
ContractHeaderId: integer
(int64)
Read Only:
true
The contract header ID. -
ContractId: integer
(int64)
Read Only:
true
Related Document Unique ID -
ContractMajorVersion: integer
(int64)
Title:
Version
Read Only:true
Default Value:1
The contract major version. -
ContractNumber: string
Title:
Document Reference
Maximum Length:120
Related Contract Number -
ContractTypeDescription: string
Read Only:
true
Maximum Length:1995
The contract type description. -
ContractTypeId: integer
Read Only:
true
The contract type ID. -
CreateEnableFlag: boolean
The create enable flag.
-
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:15
The currency code. -
DeleteEnableFlag: boolean
The delete enable flag.
-
Description: string
Title:
Description
Read Only:true
Maximum Length:1995
The description. -
DocumentTypeNew: string
Title:
Document Type
The document type new. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The end date. -
EstimatedAmount: number
Title:
Amount
Read Only:true
Default Value:0
The estimated amount. -
ExternalKey: string
Maximum Length:
120
External Key -
ExternalSource: string
Maximum Length:
120
External Source -
Id: integer
(int64)
Related Document ID
-
IntentMeaning: string
Title:
Intent
Maximum Length:80
The intent. -
JtotObject1Code: string
Maximum Length:
30
Default Value:OKX_ECMCONTRACT
The jtot object1 code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber1: integer
(int32)
Read Only:
true
The object version number1. -
ObjectVersionNumber2: integer
(int32)
Read Only:
true
The object version number2. -
OrgName: string
Read Only:
true
The org name. -
RelatedContractId: integer
(int64)
Title:
Document Reference
Related Contract ID -
RelatedObjPuid: string
Title:
Related Object PUID
Maximum Length:120
The related obj PUID. -
Relationship: string
Relationship name
-
RelationshipCode: string
Title:
Relationship
Maximum Length:30
Relationship Code -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The start date. -
StsCode: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:DRAFT
The status code. -
Type: string
Read Only:
true
Maximum Length:150
The type.
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
The following example shows how to create related documents by submitting a post request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/latest/contracts/100100069430785/child/RelatedDocument
Example of Request Body
The following shows an example of the request body in JSON format.
{ "RelationshipCode": "GOVERNED_BY", "RelatedContractId": 300100169111391 }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "Id": 300100207710059, "ChrId": 999990000000147, "CleId": null, "RelationshipCode": "GOVERNED_BY", "Relationship": "Governed by", "JtotObject1Code": "OKX_ECMCONTRACT", "RelatedContractId": 300100169111391, "Attribute26": null, "ContractHeaderId": null, "ContractNumber": null, "BuyOrSell": null, "ContractMajorVersion": null, "ContractTypeDescription": null, "ContractTypeId": null, "ExternalSource": null, "ExternalKey": null, "CreateEnableFlag": "true", "DeleteEnableFlag": "true", "DocumentTypeNew": null, "IntentMeaning": null, "ContractId": null, "CurrencyCode": null, "ObjectVersionNumber1": null, "StartDate": null, "ObjectVersionNumber2": null, "EndDate": null, "EstimatedAmount": null, "Cognomen": null, "Description": null, "StsCode": null, "OrgName": null, "Type": null, "RelatedObjPuid": "KHDR-63-1-ROBJ-554002", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/300100207710059", "name": "RelatedDocument", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/300100207710059", "name": "RelatedDocument", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785", "name": "contracts", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/300100207710059/lov/IntentLookupVO1", "name": "IntentLookupVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/300100207710059/lov/RelationshipLookupVA1", "name": "RelationshipLookupVA1", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/300100207710059/lov/ContractNumberVA", "name": "ContractNumberVA", "kind": "collection" } ] }