Get all contract documents
get
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDocuments
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.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the contract documents with the specified contract documents identifier.
Finder Variables:- AttachedDocumentId; integer; The attached document identifier.
- PrimaryKey: Finds the contract documents with the specified contract documents identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AttachedDocumentId; integer; The unique identifier of the attached internal shared document.
- CategoryName; string; The code for the category to which the internal shared document is assigned.
- CreatedBy; string; The user who created the internal shared document.
- CreatedByUserName; string; The name of the user who created the internal shared document.
- CreationDate; string; The date when the internal shared document was created.
- DatatypeCode; string; The code that identifies if the external shared document is a file or a URL.
- DmDocumentId; string; The Dm document id of the internal shared document.
- DmFolderPath; string; The Dm folder path of the internal shared document.
- DmVersionNumber; string; The Dm version number of the internal shared document.
- ExpirationDate; string; The expiration date of the internal shared document.
- FileName; string; The file name of the internal shared document. A file name or URL is required.
- LastUpdateDate; string; The date when the internal shared document was last updated.
- LastUpdatedBy; string; The login user name associated with the user who last updated the internal shared document.
- LastUpdatedByUserName; string; The name of the user who last updated the internal shared document.
- Uri; string; The URI of the internal shared document.
- Url; string; The URL of the internal shared document. A file name or URL is required.
- UserName; string; The name of the category to which the internal shared document is assigned.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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-ContractDocuments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractDocuments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The async tracker ID of the internal shared document. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached internal shared document. -
CategoryName: string
Title:
Category
Maximum Length:30
The code for the category to which the internal shared document is assigned. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the internal shared document. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The name of the user who created the internal shared document. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the internal shared document was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that identifies if the external shared document is a file or a URL. -
Description: string
Title:
Description
Maximum Length:255
The description of the internal shared document. -
DmDocumentId: string
Maximum Length:
255
The Dm document id of the internal shared document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The Dm folder path of the internal shared document. -
DmVersionNumber: string
Maximum Length:
255
The Dm version number of the internal shared document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error status code for the internal shared document. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message for the internal shared document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the internal shared document. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the internal shared document. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the internal shared document. A file name or URL is required. -
FileUrl: string
Title:
File Url
The URL location of the internal shared document. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the internal shared document was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The login user name associated with the user who last updated the internal shared document. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The name of the user who last updated the internal shared document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the internal shared document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The uploaded file content type of the internal shared document. -
UploadedFileLength: integer
Title:
File Size
The uploaded file length of the internal shared document. -
UploadedFileName: string
Title:
Uploaded File Name
The uploaded file name of the internal shared document. -
UploadedText: string
Title:
Uploaded Text
The uploaded text of the internal shared document. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the internal shared document. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the internal shared document. A file name or URL is required. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The name of the category to which the internal shared document is assigned.
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 contract documents by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET -d
@example_request_payload.json
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments/
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "AttachedDocumentId": 300100560027615, "LastUpdateDate": "2022-06-22T09:54:56.543+00:00", "LastUpdatedBy": "CONMGR", "DatatypeCode": "WEB_PAGE", "FileName": null, "DmFolderPath": null, "DmDocumentId": null, "DmVersionNumber": null, "Url": "http://www.oracle.com", "CategoryName": "OKC_DOCUMENTS_CONTRACT", "UserName": "Contract", "Uri": null, "FileUrl": null, "UploadedText": null, "UploadedFileContentType": null, "UploadedFileLength": null, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "Vision File Attachment", "Description": "Oracle Website", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "CONMGR", "CreationDate": "2022-06-22T09:54:54+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Quinn MaxOliv", "CreatedByUserName": "Quinn MaxOliv", "AsyncTrackerId": null, "DownloadInfo": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments/00020000000EACED00057708000110F09B46FFDF0000000EACED00057708000110F09B46FFDE", "name": "ContractDocuments", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments/00020000000EACED00057708000110F09B46FFDF0000000EACED00057708000110F09B46FFDE", "name": "ContractDocuments", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769", "name": "contracts", "kind": "item" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments/00020000000EACED00057708000110F09B46FFDF0000000EACED00057708000110F09B46FFDE/enclosure/FileContents", "name": "FileContents", "kind": "other" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments/00020000000EACED00057708000110F09B46FFDF0000000EACED00057708000110F09B46FFDE/enclosure/FileWebImage", "name": "FileWebImage", "kind": "other" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments", "name": "ContractDocuments", "kind": "collection" } ] }