Jump to

• Request
• Response

Create a designer layout

post

/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayoutsTotals

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• ApplicationEndPoint: string
  Maximum Length: 1000

  The name of the record type, which is a blend of the product name and the record type code.
• ApplicationType: string
  Maximum Length: 20

  The name of the product, such as LNP.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  The date when the intake form layout is no longer effective or active.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  The date when the intake form layout becomes effective.
• ExportLayout: string (byte)
  A BLOB (binary large object) that contains layout configuration metadata, such as the layout payload.
• LayoutId: integer (int64)
  The unique ID of the parent table for the layout.
• LayoutLabel: string
  Maximum Length: 200

  The label describing a designer layout.
• LayoutMetadata: string (byte)
  A BLOB (binary large object) that contains layout configuration metadata, such as the layout description, properties, and so on.
• LayoutMetadataSb: string (byte)
  The version of the sandbox for the metadata.
• LayoutType: string
  Maximum Length: 20

  It is a version of the layout, draft or published.
• LayoutVersion: string
  Title: Layout Version

  Maximum Length: 30

  The version ID assigned to a specific intake form layout.
• LayoutView: string (byte)
  The view object that stores the structure of the designer layout.
• LayoutViewSb: string (byte)
  The version of the sandbox for the layout view.
• PublishedState: string
  Maximum Length: 1

  The state of a sandbox. A sandbox can be in a state either of draft or a state of published.
• SandboxSrno: number
  The serial number of the current sandbox, starting from zero then becomes incremented by one after each publish. The sandbox ID does not get reused.
• SandboxUuid: string
  Maximum Length: 64

  The unique identifier for a sandbox.
• VersionDesc: string
  Maximum Length: 1000

  The detailed version description assigned to the intake form layout.

{
    "type":"object",
    "properties":{
        "LayoutView":{
            "type":"string",
            "description":"The view object that stores the structure of the designer layout.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ApplicationEndPoint":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the record type, which is a blend of the product name and the record type code.",
            "nullable":true
        },
        "LayoutMetadata":{
            "type":"string",
            "description":"A BLOB (binary large object) that contains layout configuration metadata, such as the layout description, properties, and so on.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "SandboxSrno":{
            "type":"number",
            "description":"The serial number of the current sandbox, starting from zero then becomes incremented by one after each publish. The sandbox ID does not get reused.",
            "nullable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date when the intake form layout is no longer effective or active.",
            "format":"date",
            "nullable":true
        },
        "PublishedState":{
            "maxLength":1,
            "type":"string",
            "description":"The state of a sandbox. A sandbox can be in a state either of draft or a state of published.",
            "nullable":true
        },
        "ExportLayout":{
            "type":"string",
            "description":"A BLOB (binary large object) that contains layout configuration metadata, such as the layout payload.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LayoutViewSb":{
            "type":"string",
            "description":"The version of the sandbox for the layout view.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SandboxUuid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for a sandbox.",
            "nullable":true
        },
        "LayoutId":{
            "type":"integer",
            "description":"The unique ID of the parent table for the layout.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LayoutType":{
            "maxLength":20,
            "type":"string",
            "description":"It is a version of the layout, draft or published.",
            "nullable":false
        },
        "LayoutVersion":{
            "title":"Layout Version",
            "maxLength":30,
            "type":"string",
            "description":"The version ID assigned to a specific intake form layout.",
            "nullable":true
        },
        "ApplicationType":{
            "maxLength":20,
            "type":"string",
            "description":"The name of the product, such as LNP.",
            "nullable":true
        },
        "LayoutLabel":{
            "maxLength":200,
            "type":"string",
            "description":"The label describing a designer layout.",
            "nullable":true
        },
        "LayoutMetadataSb":{
            "type":"string",
            "description":"The version of the sandbox for the metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "VersionDesc":{
            "maxLength":1000,
            "type":"string",
            "description":"The detailed version description assigned to the intake form layout.",
            "nullable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date when the intake form layout becomes effective.",
            "format":"date",
            "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(required):
  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(required):
  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 : publicSectorConfiguratorLayoutsTotals-item-response

Type: object

Show Source

• ApplicationEndPoint: string
  Maximum Length: 1000

  The name of the record type, which is a blend of the product name and the record type code.
• ApplicationType: string
  Maximum Length: 20

  The name of the product, such as LNP.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  The date when the intake form layout is no longer effective or active.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  The date when the intake form layout becomes effective.
• ExportLayout: string (byte)
  A BLOB (binary large object) that contains layout configuration metadata, such as the layout payload.
• LayoutId: integer (int64)
  The unique ID of the parent table for the layout.
• LayoutLabel: string
  Maximum Length: 200

  The label describing a designer layout.
• LayoutMetadata: string (byte)
  A BLOB (binary large object) that contains layout configuration metadata, such as the layout description, properties, and so on.
• LayoutMetadataSb: string (byte)
  The version of the sandbox for the metadata.
• LayoutType: string
  Maximum Length: 20

  It is a version of the layout, draft or published.
• LayoutVersion: string
  Title: Layout Version

  Maximum Length: 30

  The version ID assigned to a specific intake form layout.
• LayoutView: string (byte)
  The view object that stores the structure of the designer layout.
• LayoutViewSb: string (byte)
  The version of the sandbox for the layout view.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PublishedState: string
  Maximum Length: 1

  The state of a sandbox. A sandbox can be in a state either of draft or a state of published.
• SandboxSrno: number
  The serial number of the current sandbox, starting from zero then becomes incremented by one after each publish. The sandbox ID does not get reused.
• SandboxUuid: string
  Maximum Length: 64

  The unique identifier for a sandbox.
• VersionDesc: string
  Maximum Length: 1000

  The detailed version description assigned to the intake form layout.

{
    "type":"object",
    "properties":{
        "LayoutView":{
            "type":"string",
            "description":"The view object that stores the structure of the designer layout.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ApplicationEndPoint":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the record type, which is a blend of the product name and the record type code.",
            "nullable":true,
            "x-queryable":true
        },
        "LayoutMetadata":{
            "type":"string",
            "description":"A BLOB (binary large object) that contains layout configuration metadata, such as the layout description, properties, and so on.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "SandboxSrno":{
            "type":"number",
            "description":"The serial number of the current sandbox, starting from zero then becomes incremented by one after each publish. The sandbox ID does not get reused.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date when the intake form layout is no longer effective or active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PublishedState":{
            "maxLength":1,
            "type":"string",
            "description":"The state of a sandbox. A sandbox can be in a state either of draft or a state of published.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportLayout":{
            "type":"string",
            "description":"A BLOB (binary large object) that contains layout configuration metadata, such as the layout payload.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LayoutViewSb":{
            "type":"string",
            "description":"The version of the sandbox for the layout view.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SandboxUuid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for a sandbox.",
            "nullable":true,
            "x-queryable":true
        },
        "LayoutId":{
            "type":"integer",
            "description":"The unique ID of the parent table for the layout.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LayoutType":{
            "maxLength":20,
            "type":"string",
            "description":"It is a version of the layout, draft or published.",
            "nullable":false,
            "x-queryable":true
        },
        "LayoutVersion":{
            "title":"Layout Version",
            "maxLength":30,
            "type":"string",
            "description":"The version ID assigned to a specific intake form layout.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationType":{
            "maxLength":20,
            "type":"string",
            "description":"The name of the product, such as LNP.",
            "nullable":true,
            "x-queryable":true
        },
        "LayoutLabel":{
            "maxLength":200,
            "type":"string",
            "description":"The label describing a designer layout.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LayoutMetadataSb":{
            "type":"string",
            "description":"The version of the sandbox for the metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "VersionDesc":{
            "maxLength":1000,
            "type":"string",
            "description":"The detailed version description assigned to the intake form layout.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date when the intake form layout becomes effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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