Jump to

• Request
• Response

Create a branding theme

post

/fscmRestApi/resources/11.13.18.05/publicSectorThemeDefinitions

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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• Attributes: array Theme Attributes
  Title: Theme Attributes

  The theme attributes resource is used to view, create, modify, or delete a branding theme 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.
• Description(required): string
  Maximum Length: 100

  The full description of the branding theme.
• Label(required): string
  Maximum Length: 30

  The short description of the branding theme.
• 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.
• ThemeId(required): string
  Maximum Length: 30

  The unique identifier of the branding theme.

{
    "required":[
        "Description",
        "Label",
        "ThemeId"
    ],
    "type":"object",
    "properties":{
        "Label":{
            "maxLength":30,
            "type":"string",
            "description":"The short description of the branding theme.",
            "nullable":false
        },
        "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
        },
        "Attributes":{
            "title":"Theme Attributes",
            "type":"array",
            "description":"The theme attributes resource is used to view, create, modify, or delete a branding theme attribute.",
            "items":{
                "$ref":"#/components/schemas/publicSectorThemeDefinitions-Attributes-item-post-request"
            }
        },
        "ThemeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the branding theme.",
            "nullable":false
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The full description of the branding theme.",
            "nullable":false
        },
        "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
            }
        }
    }
}

Nested Schema : Theme Attributes

Type: array

Title: Theme Attributes

The theme attributes resource is used to view, create, modify, or delete a branding theme attribute.

Show Source

• Array of: object schema

{
    "title":"Theme Attributes",
    "type":"array",
    "description":"The theme attributes resource is used to view, create, modify, or delete a branding theme attribute.",
    "items":{
        "$ref":"#/components/schemas/publicSectorThemeDefinitions-Attributes-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AttributeId: string
  Maximum Length: 30

  The unique identifier of the branding theme attribute.
• AttributeLongValue: string
  The static long value of the branding theme attribute.
• AttributeShortValue: string
  Maximum Length: 250

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

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

  The type value of the branding theme 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.
• 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.
• ThemeId: string
  Maximum Length: 30

  The unique identifier of the branding theme.

{
    "type":"object",
    "properties":{
        "AttributeTypeValue":{
            "maxLength":4,
            "type":"string",
            "description":"The type value of the branding theme attribute.",
            "nullable":false
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the branding theme attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "ThemeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the branding theme.",
            "nullable":false
        },
        "AttributeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the branding theme attribute.",
            "nullable":false
        },
        "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
            }
        },
        "AttributeStringValue":{
            "maxLength":250,
            "type":"string",
            "description":"The label of the branding theme attribute.",
            "nullable":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
        },
        "AttributeShortValue":{
            "maxLength":250,
            "type":"string",
            "description":"The static short value of the branding theme attribute.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorThemeDefinitions-item-response

Type: object

Show Source

• Attributes: array Theme Attributes
  Title: Theme Attributes

  The theme attributes resource is used to view, create, modify, or delete a branding theme 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.
• Description: string
  Maximum Length: 100

  The full description of the branding theme.
• Label: string
  Maximum Length: 30

  The short description of the branding theme.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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.
• ThemeId: string
  Maximum Length: 30

  The unique identifier of the branding theme.

{
    "type":"object",
    "properties":{
        "ThemeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the branding theme.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The full description of the branding theme.",
            "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
        },
        "Label":{
            "maxLength":30,
            "type":"string",
            "description":"The short description of the branding theme.",
            "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 a deleted record, and false for an active record. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Attributes":{
            "title":"Theme Attributes",
            "type":"array",
            "description":"The theme attributes resource is used to view, create, modify, or delete a branding theme attribute.",
            "items":{
                "$ref":"#/components/schemas/publicSectorThemeDefinitions-Attributes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Theme Attributes

Type: array

Title: Theme Attributes

The theme attributes resource is used to view, create, modify, or delete a branding theme attribute.

Show Source

• Array of: object publicSectorThemeDefinitions-Attributes-item-response

{
    "title":"Theme Attributes",
    "type":"array",
    "description":"The theme attributes resource is used to view, create, modify, or delete a branding theme attribute.",
    "items":{
        "$ref":"#/components/schemas/publicSectorThemeDefinitions-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 : publicSectorThemeDefinitions-Attributes-item-response

Type: object

Show Source

• AttributeId: string
  Maximum Length: 30

  The unique identifier of the branding theme attribute.
• AttributeLongValue: string
  The static long value of the branding theme attribute.
• AttributeShortValue: string
  Maximum Length: 250

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

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

  The type value of the branding theme 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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.
• ThemeId: string
  Maximum Length: 30

  The unique identifier of the branding theme.

{
    "type":"object",
    "properties":{
        "AttributeTypeValue":{
            "maxLength":4,
            "type":"string",
            "description":"The type value of the branding theme attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the branding theme attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "ThemeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the branding theme.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the branding theme 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 branding theme attribute.",
            "nullable":true,
            "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"
            }
        },
        "AttributeShortValue":{
            "maxLength":250,
            "type":"string",
            "description":"The static short value of the branding theme attribute.",
            "nullable":true,
            "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/publicSectorThemeDefinitions/{ThemeId}/child/Attributes

Parameters:

• ThemeId: $request.path.ThemeId

The theme attributes resource is used to view, create, modify, or delete a branding theme attribute.

Back to Top