Get a widget
get
/fscmRestApi/resources/11.13.18.05/publicSectorWidgets/{publicSectorWidgetsUniqID}
Request
Path Parameters
-
publicSectorWidgetsUniqID: integer
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 attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorWidgets-item
Type:
Show Source
object
-
CreatedBy(optional):
string
Maximum Length:
64
The user ID of the user who created the widget -
CreationDate(optional):
string(date-time)
The date and time when the record was created.
-
DeletedFlag(optional):
string
Maximum Length:
1
Indicates if the widget is deleted. -
EffectiveEndDate(optional):
string(date)
The effective end date.
-
EffectiveStartDate(optional):
string(date)
The effective start date.
-
Enabled(optional):
string
Maximum Length:
1
Indicates if the widget is enabled and able to be used. -
HoverText(optional):
string
Maximum Length:
200
The hover text for the widget. -
LastUpdateDate(optional):
string(date-time)
The date when the record was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who updated the record most recently. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The login of the user who last updated the widget. -
LayoutMetadata(optional):
string
The JSON metadata defining the layout of the widget.
-
LayoutView(optional):
string
The layout view of the widget.
-
links(optional):
array Items
Title:
Items
Link Relations -
SeedDataLock(optional):
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(optional):
string(date)
The system effectice date.
-
WidgetAutoId(optional):
integer(int64)
A system generated unique ID.
-
WidgetClass(optional):
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(optional):
string
Maximum Length:
200
The icon for the widget. -
WidgetId(optional):
string
Maximum Length:
64
The unique identifier for a widget. -
WidgetJson(optional):
string
Maximum Length:
2000
The JSON name for the widget. -
WidgetLoader(optional):
string
Maximum Length:
20
The loader name for the widget. -
WidgetPath(optional):
string
Maximum Length:
200
The path where the widget is stored. -
WidgetTitle(optional):
string
Maximum Length:
200
The user-defined title of a widget. -
WidgetType(optional):
string
Maximum Length:
20
The type of widget, such as a reusable element, a predefined element, template, and so on.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.