Jump to

• Request
• Response

Create one contract document

post

/fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/templateUsages/{templateUsagesUniqID}/child/Section

Request

Path Parameters

• draftPurchaseAgreementsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Draft Purchase Agreements resource and used to uniquely identify an instance of Draft Purchase Agreements. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Agreements collection resource in order to navigate to a specific instance of Draft Purchase Agreements 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.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Alignment: string
  Maximum Length: 80

  Source of the template. Possible values are STRUCTURED and ATTACHED.
• AmendmentOperationCode: string
  Title: Change Type

  Maximum Length: 30
• Clause: array Contract Documents for Contract Terms
  Title: Contract Documents for Contract Terms

  Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.
• CreateFrom: string
  Source of the template. Possible values are STRUCTURED and ATTACHED.
• Description: string
  Title: Description

  Maximum Length: 2000

  Description of the contract template used in the business document.
• Heading: string
  Title: Section

  Maximum Length: 300

  Name of the contract template used in the business document.
• Id: integer
  Unique identifier for the contract template used in the business document.
• Label: string
  Maximum Length: 60

  Name of the contract template used in the business document.
• LibraryScnId: number
  Unique identifier for the contract template used in the business document.
• ScnId: number
  Unique identifier for the contract template used in the business document.
• SkipNumbering: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• StartOnNewPage: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• SubSection: array Template Usages
  Title: Template Usages

  The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.
• SuppressScnNamePrint: string
  Maximum Length: 1

  Indicates whether the contract is simple.

{
    "type":"object",
    "properties":{
        "Alignment":{
            "maxLength":80,
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true
        },
        "AmendmentOperationCode":{
            "title":"Change Type",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "Clause":{
            "title":"Contract Documents for Contract Terms",
            "type":"array",
            "description":"Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-Clause-item-post-request"
            }
        },
        "CreateFrom":{
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract template used in the business document.",
            "nullable":true
        },
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":false
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true
        },
        "LibraryScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true
        },
        "ScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        },
        "SubSection":{
            "title":"Template Usages",
            "type":"array",
            "description":"The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-item-post-request"
            }
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        }
    }
}

Nested Schema : Contract Documents for Contract Terms

Type: array

Title: Contract Documents for Contract Terms

Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.

Show Source

• Array of: object schema

{
    "title":"Contract Documents for Contract Terms",
    "type":"array",
    "description":"Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-Clause-item-post-request"
    }
}

Nested Schema : Template Usages

Type: array

Title: Template Usages

The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.

Show Source

• Array of: object schema

{
    "title":"Template Usages",
    "type":"array",
    "description":"The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AmendmentDescription: string
  Maximum Length: 2000

  Asynchronous tracker ID of the contract document.
• ArticleId: integer (int64)
  Unique identifier of the contract document.
• ArticleVersionId: number
  Unique identifier of the contract document.
• ClauseDescription: string
  Maximum Length: 2000

  Description of the contract document.
• ClauseDisplayTitle: string
  Maximum Length: 450

  Title of the contract document.
• ClauseTextInHTML: string (byte)
  HTML content of the simple contract terms.
• ClauseTitle: string
  Maximum Length: 450

  Title of the contract document.
• ClauseType: string
  Source of the template. Possible values are STRUCTURED and ATTACHED.
• SkipNumberingFlag: boolean
  Maximum Length: 1

  Indicates whether the contract is simple.
• SuppressTitleFlag: boolean
  Maximum Length: 1

  Indicates whether the contract is simple.

{
    "type":"object",
    "properties":{
        "AmendmentDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Asynchronous tracker ID of the contract document.",
            "nullable":true
        },
        "ArticleId":{
            "type":"integer",
            "description":"Unique identifier of the contract document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ArticleVersionId":{
            "type":"number",
            "description":"Unique identifier of the contract document.",
            "nullable":true
        },
        "ClauseDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract document.",
            "nullable":true
        },
        "ClauseDisplayTitle":{
            "maxLength":450,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":true
        },
        "ClauseTextInHTML":{
            "type":"string",
            "description":"HTML content of the simple contract terms.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ClauseTitle":{
            "maxLength":450,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":false
        },
        "ClauseType":{
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true
        },
        "SkipNumberingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        },
        "SuppressTitleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Alignment: string
  Maximum Length: 80

  Source of the template. Possible values are STRUCTURED and ATTACHED.
• AmendmentOperationCode: string
  Title: Change Type

  Maximum Length: 30
• Clause: array Contract Documents for Contract Terms
  Title: Contract Documents for Contract Terms

  Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.
• CreateFrom: string
  Source of the template. Possible values are STRUCTURED and ATTACHED.
• Description: string
  Title: Description

  Maximum Length: 2000

  Description of the contract template used in the business document.
• Heading: string
  Title: Section

  Maximum Length: 300

  Name of the contract template used in the business document.
• Id: integer
  Unique identifier for the contract template used in the business document.
• Label: string
  Maximum Length: 60

  Name of the contract template used in the business document.
• LibraryScnId: number
  Unique identifier for the contract template used in the business document.
• ScnId: number
  Unique identifier for the contract template used in the business document.
• SkipNumbering: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• StartOnNewPage: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• SubSection: array Template Usages
  Title: Template Usages

  The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.
• SuppressScnNamePrint: string
  Maximum Length: 1

  Indicates whether the contract is simple.

{
    "type":"object",
    "properties":{
        "Alignment":{
            "maxLength":80,
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true
        },
        "AmendmentOperationCode":{
            "title":"Change Type",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "Clause":{
            "title":"Contract Documents for Contract Terms",
            "type":"array",
            "description":"Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-Clause-item-post-request"
            }
        },
        "CreateFrom":{
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract template used in the business document.",
            "nullable":true
        },
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":false
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true
        },
        "LibraryScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true
        },
        "ScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        },
        "SubSection":{
            "title":"Template Usages",
            "type":"array",
            "description":"The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-SubSection-item-post-request"
            }
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        }
    }
}

Nested Schema : Contract Documents for Contract Terms

Type: array

Title: Contract Documents for Contract Terms

Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.

Show Source

• Array of: object schema

{
    "title":"Contract Documents for Contract Terms",
    "type":"array",
    "description":"Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-Clause-item-post-request"
    }
}

Nested Schema : Template Usages

Type: array

Title: Template Usages

The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.

Show Source

• Array of: object schema

{
    "title":"Template Usages",
    "type":"array",
    "description":"The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-SubSection-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AmendmentDescription: string
  Maximum Length: 2000

  Asynchronous tracker ID of the contract document.
• ArticleId: integer (int64)
  Unique identifier of the contract document.
• ArticleVersionId: number
  Unique identifier of the contract document.
• ClauseDescription: string
  Maximum Length: 2000

  Description of the contract document.
• ClauseDisplayTitle: string
  Maximum Length: 450

  Title of the contract document.
• ClauseTextInHTML: string (byte)
  HTML content of the simple contract terms.
• ClauseTitle: string
  Maximum Length: 450

  Title of the contract document.
• ClauseType: string
  Source of the template. Possible values are STRUCTURED and ATTACHED.
• SkipNumberingFlag: boolean
  Maximum Length: 1

  Indicates whether the contract is simple.
• SuppressTitleFlag: boolean
  Maximum Length: 1

  Indicates whether the contract is simple.

{
    "type":"object",
    "properties":{
        "AmendmentDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Asynchronous tracker ID of the contract document.",
            "nullable":true
        },
        "ArticleId":{
            "type":"integer",
            "description":"Unique identifier of the contract document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ArticleVersionId":{
            "type":"number",
            "description":"Unique identifier of the contract document.",
            "nullable":true
        },
        "ClauseDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract document.",
            "nullable":true
        },
        "ClauseDisplayTitle":{
            "maxLength":450,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":true
        },
        "ClauseTextInHTML":{
            "type":"string",
            "description":"HTML content of the simple contract terms.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ClauseTitle":{
            "maxLength":450,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":false
        },
        "ClauseType":{
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true
        },
        "SkipNumberingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        },
        "SuppressTitleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Alignment: string
  Maximum Length: 80

  Source of the template. Possible values are STRUCTURED and ATTACHED.
• AmendmentOperationCode: string
  Title: Change Type

  Maximum Length: 30
• CreateFrom: string
  Source of the template. Possible values are STRUCTURED and ATTACHED.
• Description: string
  Title: Description

  Maximum Length: 2000

  Description of the contract template used in the business document.
• Heading: string
  Title: Section

  Maximum Length: 300

  Name of the contract template used in the business document.
• Id: integer
  Unique identifier for the contract template used in the business document.
• Label: string
  Maximum Length: 60

  Name of the contract template used in the business document.
• LibraryScnId: number
  Unique identifier for the contract template used in the business document.
• ScnId: number
  Unique identifier for the contract template used in the business document.
• SkipNumbering: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• StartOnNewPage: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• SuppressScnNamePrint: string
  Maximum Length: 1

  Indicates whether the contract is simple.

{
    "type":"object",
    "properties":{
        "Alignment":{
            "maxLength":80,
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true
        },
        "AmendmentOperationCode":{
            "title":"Change Type",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "CreateFrom":{
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract template used in the business document.",
            "nullable":true
        },
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":false
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true
        },
        "LibraryScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true
        },
        "ScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true
        }
    }
}

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 : draftPurchaseAgreements-templateUsages-Section-item-response

Type: object

Show Source

• Alignment: string
  Maximum Length: 80

  Source of the template. Possible values are STRUCTURED and ATTACHED.
• AmendmentOperationCode: string
  Title: Change Type

  Maximum Length: 30
• Clause: array Contract Documents for Contract Terms
  Title: Contract Documents for Contract Terms

  Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.
• CreateFrom: string
  Source of the template. Possible values are STRUCTURED and ATTACHED.
• Description: string
  Title: Description

  Maximum Length: 2000

  Description of the contract template used in the business document.
• Heading: string
  Title: Section

  Maximum Length: 300

  Name of the contract template used in the business document.
• Id: integer
  Unique identifier for the contract template used in the business document.
• Label: string
  Maximum Length: 60

  Name of the contract template used in the business document.
• LibraryScnId: number
  Unique identifier for the contract template used in the business document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ScnId: number
  Unique identifier for the contract template used in the business document.
• SkipNumbering: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• StartOnNewPage: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• SubSection: array Template Usages
  Title: Template Usages

  The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.
• SuppressScnNamePrint: string
  Maximum Length: 1

  Indicates whether the contract is simple.

{
    "type":"object",
    "properties":{
        "Alignment":{
            "maxLength":80,
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-queryable":true
        },
        "AmendmentOperationCode":{
            "title":"Change Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Clause":{
            "title":"Contract Documents for Contract Terms",
            "type":"array",
            "description":"Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-Clause-item-response"
            }
        },
        "CreateFrom":{
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":false,
            "x-queryable":true
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "LibraryScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "x-queryable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "x-queryable":true
        },
        "SubSection":{
            "title":"Template Usages",
            "type":"array",
            "description":"The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-item-response"
            }
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "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 : Contract Documents for Contract Terms

Type: array

Title: Contract Documents for Contract Terms

Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.

Show Source

• Array of: object draftPurchaseAgreements-templateUsages-Section-Clause-item-response

{
    "title":"Contract Documents for Contract Terms",
    "type":"array",
    "description":"Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-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 : Template Usages

Type: array

Title: Template Usages

The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.

Show Source

• Array of: object draftPurchaseAgreements-templateUsages-Section-SubSection-item-response

{
    "title":"Template Usages",
    "type":"array",
    "description":"The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-item-response"
    }
}

Nested Schema : draftPurchaseAgreements-templateUsages-Section-Clause-item-response

Type: object

Show Source

• AmendmentDescription: string
  Maximum Length: 2000

  Asynchronous tracker ID of the contract document.
• AmendmentOperationCode: string
  Read Only: true

  Maximum Length: 30
• ArticleId: integer (int64)
  Unique identifier of the contract document.
• ArticleVersionId: number
  Unique identifier of the contract document.
• ArticleVersionNumber: integer (int64)
  Read Only: true

  Version number of the contract document in the content server.
• ClauseDescription: string
  Maximum Length: 2000

  Description of the contract document.
• ClauseDisplayTitle: string
  Maximum Length: 450

  Title of the contract document.
• ClauseId: integer (int64)
  Read Only: true

  Unique identifier of the contract document.
• ClauseLabel: string
  Read Only: true

  Maximum Length: 60

  Title of the contract document.
• ClauseNumber: string
  Read Only: true

  Maximum Length: 240

  Asynchronous tracker ID of the contract document.
• ClauseSection: string
  Read Only: true

  Maximum Length: 300

  Title of the contract document.
• ClauseTextInHTML: string (byte)
  HTML content of the simple contract terms.
• ClauseTextInWord: string (byte)
  Read Only: true

  HTML content of the simple contract terms.
• ClauseTitle: string
  Maximum Length: 450

  Title of the contract document.
• ClauseType: string
  Source of the template. Possible values are STRUCTURED and ATTACHED.
• ContractExpertFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract is simple.
• DocumentId: number
  Read Only: true

  Unique identifier of the contract document.
• DocumentType: string
  Read Only: true

  Maximum Length: 30

  Asynchronous tracker ID of the contract document.
• HasAlternateFlag: boolean
  Read Only: true

  Indicates whether the contract is simple.
• Id: integer (int64)
  Read Only: true

  Unique identifier of the contract document.
• IncludeByReferenceFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract is simple.
• Instructions: string
  Read Only: true

  Maximum Length: 2000

  Description of the contract document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Read Only: true

  Version number of the contract document in the content server.
• MandatoryFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract is simple.
• NonstandardFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract is simple.
• OrgId: integer (int64)
  Read Only: true

  Unique identifier of the contract document.
• ProtectedTextFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract is simple.
• ScnId: number
  Read Only: true

  Unique identifier of the contract document.
• SkipNumberingFlag: boolean
  Maximum Length: 1

  Indicates whether the contract is simple.
• SuppressTitleFlag: boolean
  Maximum Length: 1

  Indicates whether the contract is simple.

{
    "type":"object",
    "properties":{
        "AmendmentDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Asynchronous tracker ID of the contract document.",
            "nullable":true,
            "x-queryable":true
        },
        "AmendmentOperationCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ArticleId":{
            "type":"integer",
            "description":"Unique identifier of the contract document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ArticleVersionId":{
            "type":"number",
            "description":"Unique identifier of the contract document.",
            "nullable":true,
            "x-queryable":true
        },
        "ArticleVersionNumber":{
            "type":"integer",
            "description":"Version number of the contract document in the content server.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClauseDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract document.",
            "nullable":true,
            "x-queryable":true
        },
        "ClauseDisplayTitle":{
            "maxLength":450,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":true,
            "x-queryable":true
        },
        "ClauseId":{
            "type":"integer",
            "description":"Unique identifier of the contract document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClauseLabel":{
            "maxLength":60,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Asynchronous tracker ID of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseSection":{
            "maxLength":300,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseTextInHTML":{
            "type":"string",
            "description":"HTML content of the simple contract terms.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ClauseTextInWord":{
            "type":"string",
            "description":"HTML content of the simple contract terms.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClauseTitle":{
            "maxLength":450,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":false,
            "x-queryable":true
        },
        "ClauseType":{
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractExpertFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"number",
            "description":"Unique identifier of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":30,
            "type":"string",
            "description":"Asynchronous tracker ID of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasAlternateFlag":{
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"Unique identifier of the contract document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludeByReferenceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Instructions":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"Version number of the contract document in the content server.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MandatoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NonstandardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"Unique identifier of the contract document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProtectedTextFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"Unique identifier of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SkipNumberingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppressTitleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "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"
    }
}

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 : draftPurchaseAgreements-templateUsages-Section-SubSection-item-response

Type: object

Show Source

• Alignment: string
  Maximum Length: 80

  Source of the template. Possible values are STRUCTURED and ATTACHED.
• AmendmentOperationCode: string
  Title: Change Type

  Maximum Length: 30
• Clause: array Contract Documents for Contract Terms
  Title: Contract Documents for Contract Terms

  Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.
• CreateFrom: string
  Source of the template. Possible values are STRUCTURED and ATTACHED.
• Description: string
  Title: Description

  Maximum Length: 2000

  Description of the contract template used in the business document.
• Heading: string
  Title: Section

  Maximum Length: 300

  Name of the contract template used in the business document.
• Id: integer
  Unique identifier for the contract template used in the business document.
• Label: string
  Maximum Length: 60

  Name of the contract template used in the business document.
• LibraryScnId: number
  Unique identifier for the contract template used in the business document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ScnId: number
  Unique identifier for the contract template used in the business document.
• SkipNumbering: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• StartOnNewPage: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• SubSection: array Template Usages
  Title: Template Usages

  The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.
• SuppressScnNamePrint: string
  Maximum Length: 1

  Indicates whether the contract is simple.

{
    "type":"object",
    "properties":{
        "Alignment":{
            "maxLength":80,
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-queryable":true
        },
        "AmendmentOperationCode":{
            "title":"Change Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Clause":{
            "title":"Contract Documents for Contract Terms",
            "type":"array",
            "description":"Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-Clause-item-response"
            }
        },
        "CreateFrom":{
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":false,
            "x-queryable":true
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "LibraryScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "x-queryable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "x-queryable":true
        },
        "SubSection":{
            "title":"Template Usages",
            "type":"array",
            "description":"The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-SubSection-item-response"
            }
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "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 : Contract Documents for Contract Terms

Type: array

Title: Contract Documents for Contract Terms

Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.

Show Source

• Array of: object draftPurchaseAgreements-templateUsages-Section-SubSection-Clause-item-response

{
    "title":"Contract Documents for Contract Terms",
    "type":"array",
    "description":"Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-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 : Template Usages

Type: array

Title: Template Usages

The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.

Show Source

• Array of: object draftPurchaseAgreements-templateUsages-Section-SubSection-SubSection-item-response

{
    "title":"Template Usages",
    "type":"array",
    "description":"The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-templateUsages-Section-SubSection-SubSection-item-response"
    }
}

Nested Schema : draftPurchaseAgreements-templateUsages-Section-SubSection-Clause-item-response

Type: object

Show Source

• AmendmentDescription: string
  Maximum Length: 2000

  Asynchronous tracker ID of the contract document.
• AmendmentOperationCode: string
  Read Only: true

  Maximum Length: 30
• ArticleId: integer (int64)
  Unique identifier of the contract document.
• ArticleVersionId: number
  Unique identifier of the contract document.
• ArticleVersionNumber: integer (int64)
  Read Only: true

  Version number of the contract document in the content server.
• ClauseDescription: string
  Maximum Length: 2000

  Description of the contract document.
• ClauseDisplayTitle: string
  Maximum Length: 450

  Title of the contract document.
• ClauseId: integer (int64)
  Read Only: true

  Unique identifier of the contract document.
• ClauseLabel: string
  Read Only: true

  Maximum Length: 60

  Title of the contract document.
• ClauseNumber: string
  Read Only: true

  Maximum Length: 240

  Asynchronous tracker ID of the contract document.
• ClauseSection: string
  Read Only: true

  Maximum Length: 300

  Title of the contract document.
• ClauseTextInHTML: string (byte)
  HTML content of the simple contract terms.
• ClauseTextInWord: string (byte)
  Read Only: true

  HTML content of the simple contract terms.
• ClauseTitle: string
  Maximum Length: 450

  Title of the contract document.
• ClauseType: string
  Source of the template. Possible values are STRUCTURED and ATTACHED.
• ContractExpertFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract is simple.
• DocumentId: number
  Read Only: true

  Unique identifier of the contract document.
• DocumentType: string
  Read Only: true

  Maximum Length: 30

  Asynchronous tracker ID of the contract document.
• HasAlternateFlag: boolean
  Read Only: true

  Indicates whether the contract is simple.
• Id: integer (int64)
  Read Only: true

  Unique identifier of the contract document.
• IncludeByReferenceFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract is simple.
• Instructions: string
  Read Only: true

  Maximum Length: 2000

  Description of the contract document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Read Only: true

  Version number of the contract document in the content server.
• MandatoryFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract is simple.
• NonstandardFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract is simple.
• OrgId: integer (int64)
  Read Only: true

  Unique identifier of the contract document.
• ProtectedTextFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract is simple.
• ScnId: number
  Read Only: true

  Unique identifier of the contract document.
• SkipNumberingFlag: boolean
  Maximum Length: 1

  Indicates whether the contract is simple.
• SuppressTitleFlag: boolean
  Maximum Length: 1

  Indicates whether the contract is simple.

{
    "type":"object",
    "properties":{
        "AmendmentDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Asynchronous tracker ID of the contract document.",
            "nullable":true,
            "x-queryable":true
        },
        "AmendmentOperationCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ArticleId":{
            "type":"integer",
            "description":"Unique identifier of the contract document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ArticleVersionId":{
            "type":"number",
            "description":"Unique identifier of the contract document.",
            "nullable":true,
            "x-queryable":true
        },
        "ArticleVersionNumber":{
            "type":"integer",
            "description":"Version number of the contract document in the content server.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClauseDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract document.",
            "nullable":true,
            "x-queryable":true
        },
        "ClauseDisplayTitle":{
            "maxLength":450,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":true,
            "x-queryable":true
        },
        "ClauseId":{
            "type":"integer",
            "description":"Unique identifier of the contract document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClauseLabel":{
            "maxLength":60,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Asynchronous tracker ID of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseSection":{
            "maxLength":300,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseTextInHTML":{
            "type":"string",
            "description":"HTML content of the simple contract terms.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ClauseTextInWord":{
            "type":"string",
            "description":"HTML content of the simple contract terms.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClauseTitle":{
            "maxLength":450,
            "type":"string",
            "description":"Title of the contract document.",
            "nullable":false,
            "x-queryable":true
        },
        "ClauseType":{
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractExpertFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"number",
            "description":"Unique identifier of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":30,
            "type":"string",
            "description":"Asynchronous tracker ID of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasAlternateFlag":{
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"Unique identifier of the contract document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludeByReferenceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Instructions":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"Version number of the contract document in the content server.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MandatoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NonstandardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"Unique identifier of the contract document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProtectedTextFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"Unique identifier of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SkipNumberingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppressTitleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract is simple.",
            "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"
    }
}

Nested Schema : draftPurchaseAgreements-templateUsages-Section-SubSection-SubSection-item-response

Type: object

Show Source

• Alignment: string
  Maximum Length: 80

  Source of the template. Possible values are STRUCTURED and ATTACHED.
• AmendmentOperationCode: string
  Title: Change Type

  Maximum Length: 30
• CreateFrom: string
  Source of the template. Possible values are STRUCTURED and ATTACHED.
• Description: string
  Title: Description

  Maximum Length: 2000

  Description of the contract template used in the business document.
• Heading: string
  Title: Section

  Maximum Length: 300

  Name of the contract template used in the business document.
• Id: integer
  Unique identifier for the contract template used in the business document.
• Label: string
  Maximum Length: 60

  Name of the contract template used in the business document.
• LibraryScnId: number
  Unique identifier for the contract template used in the business document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ScnId: number
  Unique identifier for the contract template used in the business document.
• SkipNumbering: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• StartOnNewPage: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• SuppressScnNamePrint: string
  Maximum Length: 1

  Indicates whether the contract is simple.

{
    "type":"object",
    "properties":{
        "Alignment":{
            "maxLength":80,
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-queryable":true
        },
        "AmendmentOperationCode":{
            "title":"Change Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreateFrom":{
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":false,
            "x-queryable":true
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "LibraryScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true,
            "x-queryable":true
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "x-queryable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "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/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/templateUsages/{templateUsagesUniqID}/child/Section/{SectionUniqID}/child/Clause

Parameters:

• SectionUniqID: $request.path.SectionUniqID
• draftPurchaseAgreementsUniqID: $request.path.draftPurchaseAgreementsUniqID
• templateUsagesUniqID: $request.path.templateUsagesUniqID

Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.

SubSection

Operation: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/templateUsages/{templateUsagesUniqID}/child/Section/{SectionUniqID}/child/SubSection

Parameters:

• SectionUniqID: $request.path.SectionUniqID
• draftPurchaseAgreementsUniqID: $request.path.draftPurchaseAgreementsUniqID
• templateUsagesUniqID: $request.path.templateUsagesUniqID

The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.

Back to Top