Get a widget
get
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}
Request
Path Parameters
-
publicSectorWidgetsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- EffectiveEndDate, EffectiveStartDate and WidgetAutoId ---for the Widgets resource and used to uniquely identify an instance of Widgets. The client should not generate the hash key value. Instead, the client should query on the Widgets collection resource with a filter on the primary key values in order to navigate to a specific instance of Widgets.
For example: publicSectorWidgets?q=EffectiveEndDate=<value1>;EffectiveStartDate=<value2>;WidgetAutoId=<value3>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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(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 : publicSectorWidgets-item-response
Type:
Show Source
object
-
DeletedFlag: string
Maximum Length:
1
Indicates if the widget is deleted. -
EffectiveEndDate: string
(date)
The effective end date.
-
EffectiveStartDate: string
(date)
The effective start date.
-
Enabled: string
Maximum Length:
1
Indicates if the widget is enabled and able to be used. -
HoverText: string
Maximum Length:
200
The hover text for the widget. -
LayoutMetadata: string
(byte)
The JSON metadata defining the layout of the widget.
-
LayoutView: string
(byte)
The layout view of the widget.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Sandbox: string
Maximum Length:
60
A sandbox ID for the widget. -
SeedDataLock: integer
(int32)
Indicates whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified. The default value is 0.
-
SysEffectiveDate: string
(date)
The system effectice date.
-
WidgetAutoId: integer
(int64)
A system generated unique ID.
-
WidgetClass: string
Maximum Length:
20
The classification of the widget based on the service to which it is associated. For example, LNP for Licensing and Permitting, PZ for Planning and Zoning, or ALL for widgets that apply to all services. -
WidgetIcon: string
Maximum Length:
200
The icon for the widget. -
WidgetId: string
Maximum Length:
64
The unique identifier for a widget. -
WidgetJson: string
Maximum Length:
2000
The JSON name for the widget. -
WidgetLoader: string
Maximum Length:
20
The loader name for the widget. -
WidgetPath: string
Maximum Length:
200
The path where the widget is stored. -
WidgetTitle: string
Maximum Length:
200
The user-defined title of a widget. -
WidgetType: string
Maximum Length:
20
The type of widget, such as a reusable element, a predefined element, template, and so on.
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.