Jump to

• Request
• Response

Get a user level theme assignment plan

get

/fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}

Request

Path Parameters

• UserThemeAssignmentsUniqID(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: UserThemeAssignments?q=AgencyId=<value1>;RegistryName=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>;UserAssignmentId=<value5>
• publicSectorRegistryThemeAssignmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, RegistryName, EffectiveStartDate and EffectiveEndDate ---for the Theme Assignments resource and used to uniquely identify an instance of Theme Assignments. The client should not generate the hash key value. Instead, the client should query on the Theme Assignments collection resource with a filter on the primary key values in order to navigate to a specific instance of Theme Assignments.
  
  For example: publicSectorRegistryThemeAssignments?q=AgencyId=<value1>;RegistryName=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>

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 Top

Response

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.

Body ()

Root Schema : publicSectorRegistryThemeAssignments-UserThemeAssignments-item-response

Type: object

Show Source

• 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 a deleted record, and false for an 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.

{
    "type":"object",
    "properties":{
        "ThemeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the branding theme.",
            "nullable":false,
            "x-queryable":true
        },
        "UserAssignmentValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The value of the user attribute with which this user level theme assignment plan is associated.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with this theme assignment plan.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The end date when this theme assignment plan is in effect.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "Attributes":{
            "title":"User Theme Assignment Attributes",
            "type":"array",
            "description":"The user theme assignment attributes resource is used to view, create, modify, or delete a user level theme assignment plan attribute.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRegistryThemeAssignments-UserThemeAssignments-Attributes-item-response"
            }
        },
        "UserAssignmentTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "RegistryName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the web application to which this theme assignment plan is applied.",
            "nullable":false,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the record is logically deleted (true or false). Valid values are true for a deleted record, and false for an active record. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UserAssignmentId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the user level theme assignment plan.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The start date when this theme assignment plan is in effect.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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

• Array of: object publicSectorRegistryThemeAssignments-UserThemeAssignments-Attributes-item-response

{
    "title":"User Theme Assignment Attributes",
    "type":"array",
    "description":"The user theme assignment attributes resource is used to view, create, modify, or delete a user level theme assignment plan attribute.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRegistryThemeAssignments-UserThemeAssignments-Attributes-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorRegistryThemeAssignments-UserThemeAssignments-Attributes-item-response

Type: object

Show Source

• 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 theme assignment plan attribute.
• AttributeLongValue: string
  The static long value of the theme assignment plan attribute.
• AttributeShortValue: string
  Maximum Length: 250

  The static short value of the theme assignment plan attribute.
• AttributeStringValue: string
  Maximum Length: 250

  The label of the theme assignment plan attribute.
• AttributeTypeValue: string
  Maximum Length: 4

  The type value of the 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.

{
    "type":"object",
    "properties":{
        "AttributeTypeValue":{
            "maxLength":"4",
            "type":"string",
            "description":"The type value of the theme assignment plan attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with this theme assignment plan.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The end date when this theme assignment plan is in effect.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the theme assignment plan attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "AttributeStringValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The label of the theme assignment plan attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the theme assignment plan attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "RegistryName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the web application to which this theme assignment plan is applied.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UserAssignmentId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the user level theme assignment plan.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeShortValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The static short value of the theme assignment plan attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The start date when this theme assignment plan is in effect.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

Attributes

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRegistryThemeAssignments/{publicSectorRegistryThemeAssignmentsUniqID}/child/UserThemeAssignments/{UserThemeAssignmentsUniqID}/child/Attributes

Parameters:

• UserThemeAssignmentsUniqID: $request.path.UserThemeAssignmentsUniqID
• publicSectorRegistryThemeAssignmentsUniqID: $request.path.publicSectorRegistryThemeAssignmentsUniqID

The user theme assignment attributes resource is used to view, create, modify, or delete a user level theme assignment plan attribute.

Back to Top