Jump to

• Request
• Response

Create one contract document

post

/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/child/templateUsages/{templateUsagesUniqID}/child/Section/{SectionUniqID}/child/SubSection/{SubSectionUniqID}/child/SubSection

Request

Path Parameters

• SectionUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Template Usages resource and used to uniquely identify an instance of Template Usages. The client should not generate the hash key value. Instead, the client should query on the Template Usages collection resource in order to navigate to a specific instance of Template Usages to get the hash key.
• SubSectionUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Template Usages resource and used to uniquely identify an instance of Template Usages. The client should not generate the hash key value. Instead, the client should query on the Template Usages collection resource in order to navigate to a specific instance of Template Usages to get the hash key.
• draftPurchaseOrdersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Draft Purchase Orders resource and used to uniquely identify an instance of Draft Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Orders collection resource in order to navigate to a specific instance of Draft Purchase Orders to get the hash key.
• templateUsagesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Template Usages resource and used to uniquely identify an instance of Template Usages. The client should not generate the hash key value. Instead, the client should query on the Template Usages collection resource in order to navigate to a specific instance of Template Usages to get the hash key.

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
• 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 : draftPurchaseOrders-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"
    }
}

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."
        }
    }
}

Back to Top