Jump to

• Request
• Response

Create a subsection

post

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

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.

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

  The alignment.
• CreateFrom: string
  The create from of the subsection.
• 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.
• LibraryScnId: number
  The unique identifier of the library subsection.
• 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
        },
        "CreateFrom":{
            "type":"string",
            "description":"The create from of the subsection.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description.",
            "nullable":true
        },
        "Heading":{
            "title":"Section",
            "maxLength":300,
            "type":"string",
            "description":"The heading.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the section.",
            "nullable":false
        },
        "Label":{
            "maxLength":60,
            "type":"string",
            "description":"The label.",
            "nullable":true
        },
        "LibraryScnId":{
            "type":"number",
            "description":"The unique identifier of the library subsection.",
            "nullable":true
        },
        "ScnId":{
            "type":"number",
            "description":"The section ID.",
            "nullable":true
        },
        "SkipNumbering":{
            "maxLength":1,
            "type":"string",
            "description":"The skip numbering flag.",
            "nullable":true
        },
        "StartOnNewPage":{
            "maxLength":1,
            "type":"string",
            "description":"The start on new page flag.",
            "nullable":true
        },
        "SuppressScnNamePrint":{
            "maxLength":1,
            "type":"string",
            "description":"The suppress section name print flag.",
            "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 : contracts-Section-SubSection-item-response

Type: object

Show Source

• Alignment: string
  Maximum Length: 80

  The alignment.
• CreateFrom: string
  The create from of the subsection.
• 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.
• LibraryScnId: number
  The unique identifier of the library subsection.
• 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
        },
        "CreateFrom":{
            "type":"string",
            "description":"The create from of the subsection.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "LibraryScnId":{
            "type":"number",
            "description":"The unique identifier of the library subsection.",
            "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"
    }
}

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