Jump to

• Request
• Response

Get a section

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}

Request

Path Parameters

• 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: 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 Top

Response

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.

Body ()

Root Schema : contracts-Section-item-response

Type: object

Show Source

• Alignment: string
  Maximum Length: 80

  The alignment.
• Clause: array Clauses
  Title: Clauses

  The resource is used to view the clauses of the contract terms.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description.
• Heading: string
  Title: Section

  Maximum Length: 300

  The heading.
• Id: integer
  The unique identifier of the section.
• Label: string
  Maximum Length: 60

  The label.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ScnId: number
  The section ID.
• SkipNumbering: string
  Maximum Length: 1

  The skip numbering flag.
• StartOnNewPage: string
  Maximum Length: 1

  The start on new page flag.
• SubSection: array Sub Sections
  Title: Sub Sections

  The resource is used to view the sub sections of the contract terms.
• SuppressScnNamePrint: string
  Maximum Length: 1

  The suppress section name print flag.

{
    "type":"object",
    "properties":{
        "Alignment":{
            "maxLength":80,
            "type":"string",
            "description":"The alignment.",
            "nullable":true,
            "x-queryable":true
        },
        "Clause":{
            "title":"Clauses",
            "type":"array",
            "description":"The resource is used to view the clauses of the contract terms.",
            "items":{
                "$ref":"#/components/schemas/contracts-Section-Clause-item-response"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description.",
            "nullable":true,
            "x-queryable":true
        },
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"The heading.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the section.",
            "nullable":false,
            "x-queryable":true
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"The label.",
            "nullable":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"The section ID.",
            "nullable":true,
            "x-queryable":true
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"The skip numbering flag.",
            "nullable":true,
            "x-queryable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"The start on new page flag.",
            "nullable":true,
            "x-queryable":true
        },
        "SubSection":{
            "title":"Sub Sections",
            "type":"array",
            "description":"The resource is used to view the sub sections of the contract terms.",
            "items":{
                "$ref":"#/components/schemas/contracts-Section-SubSection-item-response"
            }
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"The suppress section name print flag.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Clauses

Type: array

Title: Clauses

The resource is used to view the clauses of the contract terms.

Show Source

• Array of: object contracts-Section-Clause-item-response

{
    "title":"Clauses",
    "type":"array",
    "description":"The resource is used to view the clauses of the contract terms.",
    "items":{
        "$ref":"#/components/schemas/contracts-Section-Clause-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Sub Sections

Type: array

Title: Sub Sections

The resource is used to view the sub sections of the contract terms.

Show Source

• Array of: object contracts-Section-SubSection-item-response

{
    "title":"Sub Sections",
    "type":"array",
    "description":"The resource is used to view the sub sections of the contract terms.",
    "items":{
        "$ref":"#/components/schemas/contracts-Section-SubSection-item-response"
    }
}

Nested Schema : contracts-Section-Clause-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ArticleId":{
            "type":"integer",
            "description":"The clause ID.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ArticleVersionId":{
            "type":"number",
            "description":"The clause version ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ArticleVersionNumber":{
            "type":"integer",
            "description":"The clause version number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClauseDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"The clause description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseDisplayTitle":{
            "maxLength":450,
            "type":"string",
            "description":"The clause display title.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseLabel":{
            "maxLength":60,
            "type":"string",
            "description":"The clause label.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseNumber":{
            "maxLength":240,
            "type":"string",
            "description":"The clause number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseSection":{
            "maxLength":300,
            "type":"string",
            "description":"The clause section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseTextInHTML":{
            "type":"string",
            "description":"The clause title in HTML.",
            "format":"byte",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ClauseTextInWord":{
            "type":"string",
            "description":"The clause title in Word.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClauseTitle":{
            "maxLength":450,
            "type":"string",
            "description":"The clause title.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseType":{
            "type":"string",
            "description":"The clause type.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractExpertFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The contract expert flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"number",
            "description":"The document ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unqiue identifier of the clause.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludeByReferenceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The include by reference flag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Instructions":{
            "maxLength":2000,
            "type":"string",
            "description":"The instructions for the clause.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"The major version associated with the clause.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MandatoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The mandatory flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NonstandardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The non standard flag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProtectedTextFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The protected text flag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"The section ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SkipNumberingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The skip numbering flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuppressTitleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The suppress title flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : contracts-Section-SubSection-item-response

Type: object

Show Source

• Alignment: string
  Maximum Length: 80

  The alignment.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description.
• Heading: string
  Title: Section

  Maximum Length: 300

  The heading.
• Id: integer
  The unique identifier of the section.
• Label: string
  Maximum Length: 60

  The label.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ScnId: number
  The section ID.
• SkipNumbering: string
  Maximum Length: 1

  The skip numbering flag.
• StartOnNewPage: string
  Maximum Length: 1

  The start on new page flag.
• SuppressScnNamePrint: string
  Maximum Length: 1

  The suppress section name print flag.

{
    "type":"object",
    "properties":{
        "Alignment":{
            "maxLength":80,
            "type":"string",
            "description":"The alignment.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description.",
            "nullable":true,
            "x-queryable":true
        },
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"The heading.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the section.",
            "nullable":false,
            "x-queryable":true
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"The label.",
            "nullable":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"The section ID.",
            "nullable":true,
            "x-queryable":true
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"The skip numbering flag.",
            "nullable":true,
            "x-queryable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"The start on new page flag.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"The suppress section name print flag.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

Clause

Operation: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/Clause

Parameters:

• SectionUniqID: $request.path.SectionUniqID
• contractsUniqID: $request.path.contractsUniqID

The resource is used to view the clauses of the contract terms.

SubSection

Operation: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/SubSection

Parameters:

• SectionUniqID: $request.path.SectionUniqID
• contractsUniqID: $request.path.contractsUniqID

The resource is used to view the sub sections of the contract terms.

Back to Top