Get a clause
get
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/Clause/{ArticleId}
Request
Path Parameters
-
ArticleId(required): integer(int64)
The clause ID.
-
SectionUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Sections resource and used to uniquely identify an instance of Sections. The client should not generate the hash key value. Instead, the client should query on the Sections collection resource in order to navigate to a specific instance of Sections 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.
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:
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-Section-Clause-item-response
Type:
Show Source
object
-
ArticleId: integer
(int64)
Read Only:
true
The clause ID. -
ArticleVersionId: number
Read Only:
true
The clause version ID. -
ArticleVersionNumber: integer
(int64)
Read Only:
true
The clause version number. -
ClauseDescription: string
Read Only:
true
Maximum Length:2000
The clause description. -
ClauseDisplayTitle: string
Read Only:
true
Maximum Length:450
The clause display title. -
ClauseLabel: string
Read Only:
true
Maximum Length:60
The clause label. -
ClauseNumber: string
Read Only:
true
Maximum Length:240
The clause number. -
ClauseSection: string
Read Only:
true
Maximum Length:300
The clause section. -
ClauseTextInHTML: string
(byte)
Read Only:
true
The clause title in HTML. -
ClauseTextInWord: string
(byte)
Read Only:
true
The clause title in Word. -
ClauseTitle: string
Read Only:
true
Maximum Length:450
The clause title. -
ClauseType: string
The clause type.
-
ContractExpertFlag: boolean
Read Only:
true
Maximum Length:1
The contract expert flag. -
DocumentId: number
Read Only:
true
The document ID. -
Id: integer
(int64)
Read Only:
true
The unqiue identifier of the clause. -
IncludeByReferenceFlag: boolean
Read Only:
true
Maximum Length:1
The include by reference flag. -
Instructions: string
Read Only:
true
Maximum Length:2000
The instructions for the clause. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Read Only:
true
The major version associated with the clause. -
MandatoryFlag: boolean
Read Only:
true
Maximum Length:1
The mandatory flag. -
NonstandardFlag: boolean
Read Only:
true
Maximum Length:1
The non standard flag. -
ProtectedTextFlag: boolean
Read Only:
true
Maximum Length:1
The protected text flag. -
ScnId: number
Read Only:
true
The section ID. -
SkipNumberingFlag: boolean
Read Only:
true
Maximum Length:1
The skip numbering flag. -
SuppressTitleFlag: boolean
Read Only:
true
Maximum Length:1
The suppress title flag.
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.