Jump to

• Request
• Response
• Examples

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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "Attribute26":{
            "maxLength":150,
            "type":"string",
            "description":"The attribute26.",
            "nullable":true
        },
        "ChrId":{
            "type":"integer",
            "description":"The contract ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CleId":{
            "type":"integer",
            "description":"The contract line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContractNumber":{
            "title":"Document Reference",
            "maxLength":120,
            "type":"string",
            "description":"Related Contract Number",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CreateEnableFlag":{
            "type":"boolean",
            "description":"The create enable flag.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteEnableFlag":{
            "type":"boolean",
            "description":"The delete enable flag.",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentTypeNew":{
            "title":"Document Type",
            "type":"string",
            "description":"The document type new.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"External Key",
            "nullable":true
        },
        "ExternalSource":{
            "maxLength":120,
            "type":"string",
            "description":"External Source",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"Related Document ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IntentMeaning":{
            "title":"Intent",
            "maxLength":80,
            "type":"string",
            "description":"The intent.",
            "nullable":true,
            "x-queryable":false
        },
        "JtotObject1Code":{
            "maxLength":30,
            "type":"string",
            "description":"The jtot object1 code.",
            "nullable":false,
            "default":"OKX_ECMCONTRACT"
        },
        "RelatedContractId":{
            "title":"Document Reference",
            "type":"integer",
            "description":"Related Contract ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedObjPuid":{
            "title":"Related Object PUID",
            "maxLength":120,
            "type":"string",
            "description":"The related obj PUID.",
            "nullable":true
        },
        "Relationship":{
            "type":"string",
            "description":"Relationship name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationshipCode":{
            "title":"Relationship",
            "maxLength":30,
            "type":"string",
            "description":"Relationship Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : contracts-RelatedDocument-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Attribute26":{
            "maxLength":150,
            "type":"string",
            "description":"The attribute26.",
            "nullable":true,
            "x-queryable":true
        },
        "BuyOrSell":{
            "title":"Intent",
            "maxLength":3,
            "type":"string",
            "description":"The intent flag.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChrId":{
            "type":"integer",
            "description":"The contract ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CleId":{
            "type":"integer",
            "description":"The contract line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Cognomen":{
            "title":"Name",
            "maxLength":300,
            "type":"string",
            "description":"The contract name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractHeaderId":{
            "type":"integer",
            "description":"The contract header ID.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Related Document Unique ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractMajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"The contract major version.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractNumber":{
            "title":"Document Reference",
            "maxLength":120,
            "type":"string",
            "description":"Related Contract Number",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ContractTypeDescription":{
            "maxLength":1995,
            "type":"string",
            "description":"The contract type description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractTypeId":{
            "type":"integer",
            "description":"The contract type ID.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreateEnableFlag":{
            "type":"boolean",
            "description":"The create enable flag.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEnableFlag":{
            "type":"boolean",
            "description":"The delete enable flag.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1995,
            "type":"string",
            "description":"The description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeNew":{
            "title":"Document Type",
            "type":"string",
            "description":"The document type new.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The estimated amount.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"External Key",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSource":{
            "maxLength":120,
            "type":"string",
            "description":"External Source",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"Related Document ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntentMeaning":{
            "title":"Intent",
            "maxLength":80,
            "type":"string",
            "description":"The intent.",
            "nullable":true,
            "x-queryable":false
        },
        "JtotObject1Code":{
            "maxLength":30,
            "type":"string",
            "description":"The jtot object1 code.",
            "nullable":false,
            "default":"OKX_ECMCONTRACT",
            "x-queryable":true
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The object version number1.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectVersionNumber2":{
            "type":"integer",
            "description":"The object version number2.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrgName":{
            "type":"string",
            "description":"The org name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedContractId":{
            "title":"Document Reference",
            "type":"integer",
            "description":"Related Contract ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedObjPuid":{
            "title":"Related Object PUID",
            "maxLength":120,
            "type":"string",
            "description":"The related obj PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "Relationship":{
            "type":"string",
            "description":"Relationship name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship",
            "maxLength":30,
            "type":"string",
            "description":"Relationship Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StsCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code.",
            "nullable":false,
            "readOnly":true,
            "default":"DRAFT",
            "x-queryable":true
        },
        "Type":{
            "maxLength":150,
            "type":"string",
            "description":"The type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

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"
        }
    ]
}

Back to Top