Jump to

• Request
• Response

Get reference template clauses

post

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractTerms/{ContractTermsUniqID}/action/getReferenceTemplateClauses

This method lets you get the reference clauses given template ID.

Request

Path Parameters

• ContractTermsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Contract Terms Templates resource and used to uniquely identify an instance of Contract Terms Templates. The client should not generate the hash key value. Instead, the client should query on the Contract Terms Templates collection resource in order to navigate to a specific instance of Contract Terms Templates to get the hash key.
• 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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• articleId: number
  The article ID.
• includeArticleText: boolean
  The indicator of whether article text should be included.
• includeArticleTextInWord: boolean
  The indicator of whether the article text in word should be included.
• referenceTemplateId: number
  The reference template ID.

{
    "type":"object",
    "properties":{
        "includeArticleTextInWord":{
            "type":"boolean",
            "description":"The indicator of whether the article text in word should be included.",
            "nullable":true
        },
        "referenceTemplateId":{
            "type":"number",
            "description":"The reference template ID.",
            "nullable":true
        },
        "includeArticleText":{
            "type":"boolean",
            "description":"The indicator of whether article text should be included.",
            "nullable":true
        },
        "articleId":{
            "type":"number",
            "description":"The article ID.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): array result
  204 Response.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"array",
            "description":"204 Response.",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: array

204 Response.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"204 Response.",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top