Get a related document
get
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RelatedDocument/{Id}
Request
Path Parameters
-
Id(required): integer(int64)
Related Document ID
-
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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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:
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 get all related document by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RelatedDocument/{Id}
Example of Response Body
The following shows an example of the response body in JSON format.
{ "Id": 100100080374461, "ChrId": 999990000000147, "CleId": null, "RelationshipCode": "RELATED_TO", "Relationship": "Related to", "JtotObject1Code": "OKX_ECMCONTRACT", "RelatedContractId": 999990000000143, "Attribute26": null, "ContractHeaderId": 999990000000143, "ContractNumber": "ECM Contract : 999990000000143", "BuyOrSell": "S", "ContractMajorVersion": 2, "ContractTypeDescription": "Sell : Project lines", "ContractTypeId": 104, "ExternalSource": null, "ExternalKey": null, "CreateEnableFlag": "true", "DeleteEnableFlag": "true", "DocumentTypeNew": "Sell : Project lines", "IntentMeaning": "Sell", "ContractId": 100100069543593, "CurrencyCode": "USD", "ObjectVersionNumber1": 3, "StartDate": "2008-05-01", "ObjectVersionNumber2": 9, "EndDate": "2008-09-04", "EstimatedAmount": 0.00, "Cognomen": "ECM Contract : 999990000000143", "Description": "ECM Contract : 999990000000143", "StsCode": "EXPIRED", "OrgName": "Vision Operations", "Type": "Sell : Project lines", "RelatedObjPuid": "ROBJ-525579", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/100100080374461", "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/100100080374461", "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/100100080374461/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/100100080374461/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/100100080374461/lov/ContractNumberVA", "name": "ContractNumberVA", "kind": "collection" } ] }