Get a user level theme assignment plan attribute
get
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}/child/Attributes/{AttributesUniqID}
Request
Path Parameters
-
AttributesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, RegistryName, EffectiveStartDate, EffectiveEndDate, UserAssignmentId and AttributeId ---for the User Theme Assignment Attributes resource and used to uniquely identify an instance of User Theme Assignment Attributes. The client should not generate the hash key value. Instead, the client should query on the User Theme Assignment Attributes collection resource with a filter on the primary key values in order to navigate to a specific instance of User Theme Assignment Attributes.
For example: Attributes?q=AgencyId=<value1>;RegistryName=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>;UserAssignmentId=<value5>;AttributeId=<value6> -
publicSectorRegistryUserThemeAssignmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, RegistryName, EffectiveStartDate, EffectiveEndDate and UserAssignmentId ---for the User Theme Assignments resource and used to uniquely identify an instance of User Theme Assignments. The client should not generate the hash key value. Instead, the client should query on the User Theme Assignments collection resource with a filter on the primary key values in order to navigate to a specific instance of User Theme Assignments.
For example: publicSectorRegistryUserThemeAssignments?q=AgencyId=<value1>;RegistryName=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>;UserAssignmentId=<value5>
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
-
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 : publicSectorRegistryUserThemeAssignments-Attributes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency that is associated with this theme assignment plan.
-
AttributeId: string
Maximum Length:
30
The unique identifier of the user level theme assignment plan attribute. -
AttributeLongValue: string
The static long value of the user level theme assignment plan attribute.
-
AttributeShortValue: string
Maximum Length:
250
The static short value of the user level theme assignment plan attribute. -
AttributeStringValue: string
Maximum Length:
250
The label of the user level theme assignment plan attribute. -
AttributeTypeValue: string
Maximum Length:
4
The type value of the user level theme assignment plan attribute. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the record is logically deleted (true or false). Valid values are true for deleted record, and false for active record. The default value is false. -
EffectiveEndDate: string
(date)
The end date when this theme assignment plan is in effect.
-
EffectiveStartDate: string
(date)
The start date when this theme assignment plan is in effect.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RegistryName: string
Maximum Length:
30
The unique identifier of the web application to which this theme assignment plan is applied. -
SeedDataLock: integer
(int32)
Default Value:
0
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. -
UserAssignmentId: string
Maximum Length:
30
The unique identifier of the user level theme assignment plan.
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.