Jump to

• Request
• Response

Update a user level theme assignment plan

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRegistryUserThemeAssignments/{publicSectorRegistryUserThemeAssignmentsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorRegistryUserThemeAssignmentsUniqID: integer
  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>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorRegistryUserThemeAssignments-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier of the agency that is associated with this theme assignment plan.
• Attributes(optional): array User Theme Assignment Attributes
  Title: User Theme Assignment Attributes

  The user theme assignments resource is used to view, create, modify, or delete a user level theme assignment plan.
• DeletedFlag(optional): string
  Maximum Length: 1

  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(optional): string(date)
  The end date when this theme assignment plan is in effect.
• EffectiveStartDate(optional): string(date)
  The start date when this theme assignment plan is in effect.
• links(optional): array Items
  Title: Items

  Link Relations
• RegistryName(optional): string
  Maximum Length: 30

  The unique identifier of the web application to which this theme assignment plan is applied.
• 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.
• SequenceNumber(optional): 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(optional): string
  Maximum Length: 30

  The unique identifier of the branding theme.
• UserAssignmentId(optional): string
  Maximum Length: 30

  The unique identifier of the user level theme assignment plan.
• UserAssignmentTypeId(optional): 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(optional): string
  Maximum Length: 250

  The value of the user attribute with which this user level theme assignment plan is associated.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with this theme assignment plan."
        },
        "Attributes":{
            "items":{
                "$ref":"#/definitions/publicSectorRegistryUserThemeAssignments-Attributes-item"
            },
            "type":"array",
            "description":"The user theme assignments resource is used to view, create, modify, or delete a user level theme assignment plan.",
            "title":"User Theme Assignment Attributes"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "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."
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The end date when this theme assignment plan is in effect."
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date when this theme assignment plan is in effect."
        },
        "RegistryName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the web application to which this theme assignment plan is applied."
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "SequenceNumber":{
            "format":"int32",
            "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."
        },
        "ThemeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the branding theme."
        },
        "UserAssignmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the user level theme assignment plan."
        },
        "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."
        },
        "UserAssignmentValue":{
            "maxLength":250,
            "type":"string",
            "description":"The value of the user attribute with which this user level theme assignment plan is associated."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : User Theme Assignment Attributes

Type: array

Title: User Theme Assignment Attributes

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

Show Source

• Array of: object publicSectorRegistryUserThemeAssignments-Attributes-item

{
    "items":{
        "$ref":"#/definitions/publicSectorRegistryUserThemeAssignments-Attributes-item"
    },
    "type":"array",
    "description":"The user theme assignments resource is used to view, create, modify, or delete a user level theme assignment plan.",
    "title":"User Theme Assignment Attributes"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorRegistryUserThemeAssignments-Attributes-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier of the agency that is associated with this theme assignment plan.
• AttributeId(optional): string
  Maximum Length: 30

  The unique identifier of the user level theme assignment plan attribute.
• AttributeLongValue(optional): string
  The static long value of the user level theme assignment plan attribute.
• AttributeShortValue(optional): string
  Maximum Length: 250

  The static short value of the user level theme assignment plan attribute.
• AttributeStringValue(optional): string
  Maximum Length: 250

  The label of the user level theme assignment plan attribute.
• AttributeTypeValue(optional): string
  Maximum Length: 4

  The type value of the user level theme assignment plan attribute.
• EffectiveEndDate(optional): string(date)
  The end date when this theme assignment plan is in effect.
• EffectiveStartDate(optional): string(date)
  The start date when this theme assignment plan is in effect.
• links(optional): array Items
  Title: Items

  Link Relations
• RegistryName(optional): string
  Maximum Length: 30

  The unique identifier of the web application to which this theme assignment plan is applied.
• UserAssignmentId(optional): string
  Maximum Length: 30

  The unique identifier of the user level theme assignment plan.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with this theme assignment plan."
        },
        "AttributeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the user level theme assignment plan attribute."
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the user level theme assignment plan attribute."
        },
        "AttributeShortValue":{
            "maxLength":250,
            "type":"string",
            "description":"The static short value of the user level theme assignment plan attribute."
        },
        "AttributeStringValue":{
            "maxLength":250,
            "type":"string",
            "description":"The label of the user level theme assignment plan attribute."
        },
        "AttributeTypeValue":{
            "maxLength":4,
            "type":"string",
            "description":"The type value of the user level theme assignment plan attribute."
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The end date when this theme assignment plan is in effect."
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date when this theme assignment plan is in effect."
        },
        "RegistryName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the web application to which this theme assignment plan is applied."
        },
        "UserAssignmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the user level theme assignment plan."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorRegistryUserThemeAssignments-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier of the agency that is associated with this theme assignment plan.
• Attributes(optional): array User Theme Assignment Attributes
  Title: User Theme Assignment Attributes

  The user theme assignments resource is used to view, create, modify, or delete a user level theme assignment plan.
• DeletedFlag(optional): string
  Maximum Length: 1

  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(optional): string(date)
  The end date when this theme assignment plan is in effect.
• EffectiveStartDate(optional): string(date)
  The start date when this theme assignment plan is in effect.
• links(optional): array Items
  Title: Items

  Link Relations
• RegistryName(optional): string
  Maximum Length: 30

  The unique identifier of the web application to which this theme assignment plan is applied.
• 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.
• SequenceNumber(optional): 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(optional): string
  Maximum Length: 30

  The unique identifier of the branding theme.
• UserAssignmentId(optional): string
  Maximum Length: 30

  The unique identifier of the user level theme assignment plan.
• UserAssignmentTypeId(optional): 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(optional): string
  Maximum Length: 250

  The value of the user attribute with which this user level theme assignment plan is associated.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with this theme assignment plan."
        },
        "Attributes":{
            "items":{
                "$ref":"#/definitions/publicSectorRegistryUserThemeAssignments-Attributes-item"
            },
            "type":"array",
            "description":"The user theme assignments resource is used to view, create, modify, or delete a user level theme assignment plan.",
            "title":"User Theme Assignment Attributes"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "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."
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The end date when this theme assignment plan is in effect."
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date when this theme assignment plan is in effect."
        },
        "RegistryName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the web application to which this theme assignment plan is applied."
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "SequenceNumber":{
            "format":"int32",
            "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."
        },
        "ThemeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the branding theme."
        },
        "UserAssignmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the user level theme assignment plan."
        },
        "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."
        },
        "UserAssignmentValue":{
            "maxLength":250,
            "type":"string",
            "description":"The value of the user attribute with which this user level theme assignment plan is associated."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : User Theme Assignment Attributes

Type: array

Title: User Theme Assignment Attributes

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

Show Source

• Array of: object publicSectorRegistryUserThemeAssignments-Attributes-item

{
    "items":{
        "$ref":"#/definitions/publicSectorRegistryUserThemeAssignments-Attributes-item"
    },
    "type":"array",
    "description":"The user theme assignments resource is used to view, create, modify, or delete a user level theme assignment plan.",
    "title":"User Theme Assignment Attributes"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorRegistryUserThemeAssignments-Attributes-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier of the agency that is associated with this theme assignment plan.
• AttributeId(optional): string
  Maximum Length: 30

  The unique identifier of the user level theme assignment plan attribute.
• AttributeLongValue(optional): string
  The static long value of the user level theme assignment plan attribute.
• AttributeShortValue(optional): string
  Maximum Length: 250

  The static short value of the user level theme assignment plan attribute.
• AttributeStringValue(optional): string
  Maximum Length: 250

  The label of the user level theme assignment plan attribute.
• AttributeTypeValue(optional): string
  Maximum Length: 4

  The type value of the user level theme assignment plan attribute.
• EffectiveEndDate(optional): string(date)
  The end date when this theme assignment plan is in effect.
• EffectiveStartDate(optional): string(date)
  The start date when this theme assignment plan is in effect.
• links(optional): array Items
  Title: Items

  Link Relations
• RegistryName(optional): string
  Maximum Length: 30

  The unique identifier of the web application to which this theme assignment plan is applied.
• UserAssignmentId(optional): string
  Maximum Length: 30

  The unique identifier of the user level theme assignment plan.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with this theme assignment plan."
        },
        "AttributeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the user level theme assignment plan attribute."
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the user level theme assignment plan attribute."
        },
        "AttributeShortValue":{
            "maxLength":250,
            "type":"string",
            "description":"The static short value of the user level theme assignment plan attribute."
        },
        "AttributeStringValue":{
            "maxLength":250,
            "type":"string",
            "description":"The label of the user level theme assignment plan attribute."
        },
        "AttributeTypeValue":{
            "maxLength":4,
            "type":"string",
            "description":"The type value of the user level theme assignment plan attribute."
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The end date when this theme assignment plan is in effect."
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date when this theme assignment plan is in effect."
        },
        "RegistryName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the web application to which this theme assignment plan is applied."
        },
        "UserAssignmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the user level theme assignment plan."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top