Create a designer layout
post
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts
Request
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
Root Schema : schema
Type:
Show Source
object
-
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
Name of the offering, 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 identifier for a designer 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. -
SaveType: string
The type of save action, as in publish, revert to save.
-
VersionDesc: string
Maximum Length:
1000
The detailed version description assigned to the intake form layout.
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.
Root Schema : publicSectorConfiguratorLayouts-item-response
Type:
Show Source
object
-
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
Name of the offering, 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 identifier for a designer 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. -
SaveType: string
The type of save action, as in publish, revert to save.
-
VersionDesc: string
Maximum Length:
1000
The detailed version description assigned to the intake form layout.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.