Create a user level theme assignment plan
post
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments
Request
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.
-
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
-
AgencyId(required): integer
(int32)
The unique identifier of the agency that is associated with this theme assignment plan.
-
Attributes: array
User Theme Assignment Attributes
Title:
User Theme Assignment Attributes
The user theme assignment attributes resource is used to view, create, modify, or delete a 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(required): string
(date)
The end date when this theme assignment plan is in effect.
-
EffectiveStartDate(required): string
(date)
The start date when this theme assignment plan is in effect.
-
RegistryName(required): 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. -
SequenceNumber(required): integer
(int32)
The sequence number of the user level theme assignment plan. When a user has multiple matches, the one with the lowest sequence number is used.
-
ThemeId(required): string
Maximum Length:
30
The unique identifier of the branding theme. -
UserAssignmentId(required): string
Maximum Length:
30
The unique identifier of the user level theme assignment plan. -
UserAssignmentTypeId(required): string
Maximum Length:
30
Indicates the type of the user attribute this user level theme assignment plan is based on. The valid value is ROLE for a user security role based theme assignment plan. -
UserAssignmentValue(required): string
Maximum Length:
250
The value of the user attribute with which this user level theme assignment plan is associated.
Nested Schema : User Theme Assignment Attributes
Type:
array
Title:
User Theme Assignment Attributes
The user theme assignment attributes resource is used to view, create, modify, or delete a user level theme assignment plan attribute.
Show Source
Nested Schema : schema
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.
-
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.
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 : publicSectorRegistryUserThemeAssignments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency that is associated with this theme assignment plan.
-
Attributes: array
User Theme Assignment Attributes
Title:
User Theme Assignment Attributes
The user theme assignment attributes resource is used to view, create, modify, or delete a 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. -
SequenceNumber: integer
(int32)
The sequence number of the user level theme assignment plan. When a user has multiple matches, the one with the lowest sequence number is used.
-
ThemeId: string
Maximum Length:
30
The unique identifier of the branding theme. -
UserAssignmentId: string
Maximum Length:
30
The unique identifier of the user level theme assignment plan. -
UserAssignmentTypeId: string
Maximum Length:
30
Indicates the type of the user attribute this user level theme assignment plan is based on. The valid value is ROLE for a user security role based theme assignment plan. -
UserAssignmentValue: string
Maximum Length:
250
The value of the user attribute with which this user level theme assignment plan is associated.
Nested Schema : User Theme Assignment Attributes
Type:
array
Title:
User Theme Assignment Attributes
The user theme assignment attributes resource is used to view, create, modify, or delete a user level theme assignment plan attribute.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.
Links
- Attributes
-
Parameters:
- publicSectorRegistryUserThemeAssignmentsUniqID:
$request.path.publicSectorRegistryUserThemeAssignmentsUniqID
The user theme assignment attributes resource is used to view, create, modify, or delete a user level theme assignment plan attribute. - publicSectorRegistryUserThemeAssignmentsUniqID: