Get one contract document
get
/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/child/templateUsages/{templateUsagesUniqID}/child/Section/{SectionUniqID}/child/Clause/{ClauseUniqID}
Request
Path Parameters
-
ClauseUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Contract Documents for Contract Terms resource and used to uniquely identify an instance of Contract Documents for Contract Terms. The client should not generate the hash key value. Instead, the client should query on the Contract Documents for Contract Terms collection resource in order to navigate to a specific instance of Contract Documents for Contract Terms to get the hash key.
-
SectionUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Template Usages resource and used to uniquely identify an instance of Template Usages. The client should not generate the hash key value. Instead, the client should query on the Template Usages collection resource in order to navigate to a specific instance of Template Usages to get the hash key.
-
draftPurchaseOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Draft Purchase Orders resource and used to uniquely identify an instance of Draft Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Orders collection resource in order to navigate to a specific instance of Draft Purchase Orders to get the hash key.
-
templateUsagesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Template Usages resource and used to uniquely identify an instance of Template Usages. The client should not generate the hash key value. Instead, the client should query on the Template Usages collection resource in order to navigate to a specific instance of Template Usages 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: 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.
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 : draftPurchaseOrders-templateUsages-Section-Clause-item-response
Type:
Show Source
object-
AmendmentDescription: string
Maximum Length:
2000Asynchronous tracker ID of the contract document. -
AmendmentOperationCode: string
Read Only:
trueMaximum Length:30 -
ArticleId: integer
(int64)
Unique identifier of the contract document.
-
ArticleVersionId: number
Unique identifier of the contract document.
-
ArticleVersionNumber: integer
(int64)
Read Only:
trueVersion number of the contract document in the content server. -
ClauseDescription: string
Maximum Length:
2000Description of the contract document. -
ClauseDisplayTitle: string
Maximum Length:
450Title of the contract document. -
ClauseId: integer
(int64)
Read Only:
trueUnique identifier of the contract document. -
ClauseLabel: string
Read Only:
trueMaximum Length:60Title of the contract document. -
ClauseNumber: string
Read Only:
trueMaximum Length:240Asynchronous tracker ID of the contract document. -
ClauseSection: string
Read Only:
trueMaximum Length:300Title of the contract document. -
ClauseTextInHTML: string
(byte)
HTML content of the simple contract terms.
-
ClauseTextInWord: string
(byte)
Read Only:
trueHTML content of the simple contract terms. -
ClauseTitle: string
Maximum Length:
450Title of the contract document. -
ClauseType: string
Source of the template. Possible values are STRUCTURED and ATTACHED.
-
ContractExpertFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the contract is simple. -
DocumentId: number
Read Only:
trueUnique identifier of the contract document. -
DocumentType: string
Read Only:
trueMaximum Length:30Asynchronous tracker ID of the contract document. -
HasAlternateFlag: boolean
Read Only:
trueIndicates whether the contract is simple. -
Id: integer
(int64)
Read Only:
trueUnique identifier of the contract document. -
IncludeByReferenceFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the contract is simple. -
Instructions: string
Read Only:
trueMaximum Length:2000Description of the contract document. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Read Only:
trueVersion number of the contract document in the content server. -
MandatoryFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the contract is simple. -
NonstandardFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the contract is simple. -
OrgId: integer
(int64)
Read Only:
trueUnique identifier of the contract document. -
ProtectedTextFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the contract is simple. -
ScnId: number
Read Only:
trueUnique identifier of the contract document. -
SkipNumberingFlag: boolean
Maximum Length:
1Indicates whether the contract is simple. -
SuppressTitleFlag: boolean
Maximum Length:
1Indicates whether the contract is simple.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.