Get all designer layouts
get
/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- AltKey: Finds a designer layout with the specified alternate key.
Finder Variables:- ApplicationEndPoint; string; Finds a designer layout using the provided application end point, which is comprised of the product name and the record type code.
- ApplicationType; string; Finds a designer layout with the provided name of the product. For example, LNP.
- LayoutVersion; string; Finds a designer layout type with the specified layout version.
- LayoutRowFinder: Finds a designer layout with the specified primary key.
Finder Variables:- SysEffectiveDate; object.
- PrimaryKey: Finds a designer layout type with the specified primary key.
Finder Variables:- EffectiveEndDate; string; The date when the intake form layout is no longer effective or active.
- EffectiveStartDate; string; The date when the intake form layout becomes effective.
- LayoutId; integer; The unique identifier for a designer layout.
- RowFinder: Finds a designer layout with the specified primary key.
Finder Variables:- SysEffectiveDate; object.
- AltKey: Finds a designer layout with the specified alternate key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ApplicationEndPoint; string; The name of the record type, which is a blend of the product name and the record type code.
- ApplicationType; string; Name of the offering, such as LNP.
- EffectiveEndDate; string; The date when the intake form layout is no longer effective or active.
- EffectiveStartDate; string; The date when the intake form layout becomes effective.
- LayoutId; integer; The unique identifier for a designer layout.
- LayoutLabel; string; The label describing a designer layout.
- LayoutType; string; It is a version of the layout, draft or published.
- LayoutVersion; string; The version ID assigned to a specific intake form layout.
- PublishedState; string; 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; The unique identifier for a sandbox.
- VersionDesc; string; The detailed version description assigned to the intake form layout.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : publicSectorConfiguratorLayouts
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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. -
RecordDescribe: string
(byte)
The describe record stucture of the permit type.
-
ReleaseVersion: string
The release version of record describe.
-
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.