Get Document Metadata
get
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}
This service returns the metadata for a specific Commerce document.
Request
Path Parameters
-
docVarName(required): string
The variable name of the Commerce document
-
processVarName(required): string
The variable name of the Commerce process
Response
Default Response
Root Schema : CommerceProcessDocuments
Type:
Show Source
object
-
dateModified:
string
Title:
Date Last Modified
System field indicating the date on which the object was last modified. -
description:
string
Title:
Description
Description -
id:
integer
Title:
Id
Primary Key of Commerce Documents. -
label:
string
Title:
Display Name
Document Name -
links:
object Reference Links
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Reference Links
Type:
object
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
href
URL to the related object -
rel:
string
Title:
Link
Link relationship to the current object
Examples
The following example shows how to retrieve the document metadata for a Commerce document. by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents
Response Body Sample
{ "items": [{ "id": 36244074, "dateModified": "2019-02-01", "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/attributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/actionDefs" } ], "variableName": "transaction", "label": "Transaction", "description": "Main (Header Level) Commerce Document - serves as Quote/Order depending on step in process flow", "resourceVarName": "commerceDocumentsOraclecpqoTransaction", "type": { "lookupCode": "0", "displayValue": "Main Document" }, "process": { "id": 36244034, "variableName": "oraclecpqo" } }, { "id": 36244118, "dateModified": "2017-11-17", "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transactionLine" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transactionLine/attributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transactionLine/actionDefs" } ], "variableName": "transactionLine", "label": "Transaction Line", "description": "Line Level Document - Captures pricing and data at the line level", "resourceVarName": "commerceDocumentsOraclecpqoTransactionTransactionLine", "type": { "lookupCode": "1", "displayValue": "Sub Document" }, "process": { "id": 36244034, "variableName": "oraclecpqo" } } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents" } ], }