Jump to

• Request
• Response

Update a toolbar

patch

/crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}

Request

Path Parameters

• ToolbarId(required): integer(int64)
  The auto-generated number and primary key for the toolbar.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Status

  Maximum Length: 1

  Default Value: true

  Indicates whether the toolbar is available for use.
• ChatSupportedFlag: boolean
  Title: Chat Supported

  Indicates whether chat is supported.
• DefaultVisibleFlag: boolean
  Title: Default Visible

  Maximum Length: 1

  Default Value: true

  Indicates whether the toolbar should be visible by default
• DisplayName(required): string
  Title: Toolbar Name

  Maximum Length: 80

  The user friendly name of the toolbar.
• Layout: string
  The user friendly description of the layout.
• LwAcceptOnFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates the Accept/Reject dialog should be shown in Live Window for incoming engagements from this toolbar.
• McaToolbarAddition: array Multi-Channel Adapter Toolbar Additions
  Title: Multi-Channel Adapter Toolbar Additions

  The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.
• Name(required): string
  Title: Name

  Maximum Length: 64

  The name of the toolbar.
• NrtWorkSupportedFlag: boolean
  Title: Non-Real-Time Work Supported

  Indicates whether NRT is supported.
• Orientation(required): string
  Maximum Length: 20

  The orientation of the toolbar. Either HORIZONTAL or VERTICAL
• PhoneSupportedFlag: boolean
  Title: Phone Supported

  Indicates whether the phone is supported.
• PreferredHeight(required): integer (int64)
  Title: Height

  The preferred height of the toolbar in pixels.
• PreferredWidth: integer (int64)
  Title: Width

  The preferred width of the toolbar in pixels.
• SupportedChannels: string
  Title: Supported Channels

  Maximum Length: 200

  The comma delimited list of channel types supported by the toolbar.
• ToolbarLabel: string
  Maximum Length: 64

  The user friendly label for the toolbar.
• Url(required): string
  Title: URL

  Maximum Length: 500

  The URL for the toolbar rendering.
• UrlValidDomainName: string
  Maximum Length: 200

  The domain name for optional redirection.
• Vendor: string
  Maximum Length: 64

  The optional field for the name of the vendor.

{
    "required":[
        "DisplayName",
        "Name",
        "Orientation",
        "PreferredHeight",
        "Url"
    ],
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Status",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the toolbar is available for use.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "help":{
                    "instruction":"Status"
                }
            }
        },
        "ChatSupportedFlag":{
            "title":"Chat Supported",
            "type":"boolean",
            "description":"Indicates whether chat is supported.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Chat Supported"
                }
            }
        },
        "DefaultVisibleFlag":{
            "title":"Default Visible",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the toolbar should be visible by default",
            "nullable":true,
            "default":true,
            "x-hints":{
                "help":{
                    "instruction":"Default Visible"
                }
            }
        },
        "DisplayName":{
            "title":"Toolbar Name",
            "maxLength":80,
            "type":"string",
            "description":"The user friendly name of the toolbar.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Toolbar Name"
                }
            }
        },
        "Layout":{
            "type":"string",
            "description":"The user friendly description of the layout.",
            "nullable":true
        },
        "LwAcceptOnFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the Accept/Reject dialog should be shown in Live Window for incoming engagements from this toolbar.",
            "nullable":true,
            "default":true
        },
        "McaToolbarAddition":{
            "title":"Multi-Channel Adapter Toolbar Additions",
            "type":"array",
            "description":"The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.",
            "items":{
                "$ref":"#/components/schemas/multiChannelAdapterToolbars-McaToolbarAddition-item-patch-request"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the toolbar.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Name"
                }
            }
        },
        "NrtWorkSupportedFlag":{
            "title":"Non-Real-Time Work Supported",
            "type":"boolean",
            "description":"Indicates whether NRT is supported.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Non-Real-Time Work Supported"
                }
            }
        },
        "Orientation":{
            "maxLength":20,
            "type":"string",
            "description":"The orientation of the toolbar.  Either HORIZONTAL or VERTICAL",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhoneSupportedFlag":{
            "title":"Phone Supported",
            "type":"boolean",
            "description":"Indicates whether the phone is supported.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Phone Supported"
                }
            }
        },
        "PreferredHeight":{
            "title":"Height",
            "type":"integer",
            "description":"The preferred height of the toolbar in pixels.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Height"
                },
                "precision":10
            }
        },
        "PreferredWidth":{
            "title":"Width",
            "type":"integer",
            "description":"The preferred width of the toolbar in pixels.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Width"
                },
                "precision":10
            }
        },
        "SupportedChannels":{
            "title":"Supported Channels",
            "maxLength":200,
            "type":"string",
            "description":"The comma delimited list of channel types supported by the toolbar.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Supported Channels"
                }
            }
        },
        "ToolbarLabel":{
            "maxLength":64,
            "type":"string",
            "description":"The user friendly label for the toolbar.",
            "nullable":true
        },
        "Url":{
            "title":"URL",
            "maxLength":500,
            "type":"string",
            "description":"The URL for the toolbar rendering.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"URL"
                }
            }
        },
        "UrlValidDomainName":{
            "maxLength":200,
            "type":"string",
            "description":"The domain name for optional redirection.",
            "nullable":true
        },
        "Vendor":{
            "maxLength":64,
            "type":"string",
            "description":"The optional field for the name of the vendor.",
            "nullable":true
        }
    }
}

Nested Schema : Multi-Channel Adapter Toolbar Additions

Type: array

Title: Multi-Channel Adapter Toolbar Additions

The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.

Show Source

• Array of: object schema

{
    "title":"Multi-Channel Adapter Toolbar Additions",
    "type":"array",
    "description":"The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.",
    "items":{
        "$ref":"#/components/schemas/multiChannelAdapterToolbars-McaToolbarAddition-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the additional toolbar is available for use.
• AdditionalTlbType: string
  Title: Additional Toolbar Type

  Maximum Length: 30

  The type of additional toolbar being configured.
• DefaultVisibleFlag: boolean
  Title: Default Visible

  Maximum Length: 1

  Default Value: true

  Indicates whether the additional toolbar should be visible by default.
• PreferredHeight: integer (int64)
  Title: Height

  The preferred height of the additional toolbar in pixels.
• PreferredWidth: integer (int64)
  Title: Width

  The preferred width of the additional toolbar in pixels.
• ToolbarId: integer (int64)
  Title: Toolbar ID

  The foreign key to the parent toolbar
• ToolbarLabel: string
  Maximum Length: 25

  The user friendly label for the additional toolbar.
• Url: string
  Title: URL

  Maximum Length: 500

  The URL for the additional toolbar rendering.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the additional toolbar is available for use.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "help":{
                    "instruction":"Active"
                },
                "controlType":"choice"
            }
        },
        "AdditionalTlbType":{
            "title":"Additional Toolbar Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of additional toolbar being configured.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Additional Toolbar Type"
                },
                "controlType":"choice"
            }
        },
        "DefaultVisibleFlag":{
            "title":"Default Visible",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the additional toolbar should be visible by default.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "help":{
                    "instruction":"Default Visible"
                },
                "controlType":"choice"
            }
        },
        "PreferredHeight":{
            "title":"Height",
            "type":"integer",
            "description":"The preferred height of the additional toolbar in pixels.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Height"
                },
                "precision":10
            }
        },
        "PreferredWidth":{
            "title":"Width",
            "type":"integer",
            "description":"The preferred width of the additional toolbar in pixels.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Width"
                },
                "precision":10
            }
        },
        "ToolbarId":{
            "title":"Toolbar ID",
            "type":"integer",
            "description":"The foreign key to the parent toolbar",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ToolbarLabel":{
            "maxLength":25,
            "type":"string",
            "description":"The user friendly label for the additional toolbar.",
            "nullable":true
        },
        "Url":{
            "title":"URL",
            "maxLength":500,
            "type":"string",
            "description":"The URL for the additional toolbar rendering.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"URL"
                }
            }
        }
    }
}

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 : multiChannelAdapterToolbars-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Status

  Maximum Length: 1

  Default Value: true

  Indicates whether the toolbar is available for use.
• ChatSupportedFlag: boolean
  Title: Chat Supported

  Indicates whether chat is supported.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the toolbar.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the toolbar was created.
• DefaultVisibleFlag: boolean
  Title: Default Visible

  Maximum Length: 1

  Default Value: true

  Indicates whether the toolbar should be visible by default
• DisplayName: string
  Title: Toolbar Name

  Maximum Length: 80

  The user friendly name of the toolbar.
• LastUpdateDate: string (date-time)
  Read Only: true

  The user who last updated the toolbar.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The date when the toolbar was last updated.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the toolbar.
• Layout: string
  The user friendly description of the layout.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LwAcceptOnFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates the Accept/Reject dialog should be shown in Live Window for incoming engagements from this toolbar.
• McaToolbarAddition: array Multi-Channel Adapter Toolbar Additions
  Title: Multi-Channel Adapter Toolbar Additions

  The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.
• Name: string
  Title: Name

  Maximum Length: 64

  The name of the toolbar.
• NrtWorkSupportedFlag: boolean
  Title: Non-Real-Time Work Supported

  Indicates whether NRT is supported.
• Orientation: string
  Maximum Length: 20

  The orientation of the toolbar. Either HORIZONTAL or VERTICAL
• OverrideToolbarProfile: string
  Read Only: true

  The profile value for SVC_OVERRIDE_PARTNER_TOOLBAR_SELECTION profile name.
• PhoneSupportedFlag: boolean
  Title: Phone Supported

  Indicates whether the phone is supported.
• PreferredHeight: integer (int64)
  Title: Height

  The preferred height of the toolbar in pixels.
• PreferredWidth: integer (int64)
  Title: Width

  The preferred width of the toolbar in pixels.
• SupportedChannels: string
  Title: Supported Channels

  Maximum Length: 200

  The comma delimited list of channel types supported by the toolbar.
• ToolbarEnabledProfile: string
  Read Only: true

  The profile value for SVC_PARTNER_MEDIA_TOOLBAR_ENABLED profile name.
• ToolbarId: integer (int64)
  Title: Toolbar ID

  Read Only: true

  The auto-generated number and primary key for the toolbar.
• ToolbarLabel: string
  Maximum Length: 64

  The user friendly label for the toolbar.
• Url: string
  Title: URL

  Maximum Length: 500

  The URL for the toolbar rendering.
• UrlValidDomainName: string
  Maximum Length: 200

  The domain name for optional redirection.
• Vendor: string
  Maximum Length: 64

  The optional field for the name of the vendor.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Status",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the toolbar is available for use.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "help":{
                    "instruction":"Status"
                }
            },
            "x-queryable":true
        },
        "ChatSupportedFlag":{
            "title":"Chat Supported",
            "type":"boolean",
            "description":"Indicates whether chat is supported.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Chat Supported"
                }
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the toolbar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the toolbar was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultVisibleFlag":{
            "title":"Default Visible",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the toolbar should be visible by default",
            "nullable":true,
            "default":true,
            "x-hints":{
                "help":{
                    "instruction":"Default Visible"
                }
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Toolbar Name",
            "maxLength":80,
            "type":"string",
            "description":"The user friendly name of the toolbar.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Toolbar Name"
                }
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the toolbar.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the toolbar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date when the toolbar was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Layout":{
            "type":"string",
            "description":"The user friendly description of the layout.",
            "nullable":true,
            "x-queryable":true
        },
        "LwAcceptOnFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the Accept/Reject dialog should be shown in Live Window for incoming engagements from this toolbar.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "McaToolbarAddition":{
            "title":"Multi-Channel Adapter Toolbar Additions",
            "type":"array",
            "description":"The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.",
            "items":{
                "$ref":"#/components/schemas/multiChannelAdapterToolbars-McaToolbarAddition-item-response"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the toolbar.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Name"
                }
            },
            "x-queryable":true
        },
        "NrtWorkSupportedFlag":{
            "title":"Non-Real-Time Work Supported",
            "type":"boolean",
            "description":"Indicates whether NRT is supported.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Non-Real-Time Work Supported"
                }
            }
        },
        "Orientation":{
            "maxLength":20,
            "type":"string",
            "description":"The orientation of the toolbar.  Either HORIZONTAL or VERTICAL",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverrideToolbarProfile":{
            "type":"string",
            "description":"The profile value for SVC_OVERRIDE_PARTNER_TOOLBAR_SELECTION profile name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneSupportedFlag":{
            "title":"Phone Supported",
            "type":"boolean",
            "description":"Indicates whether the phone is supported.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Phone Supported"
                }
            }
        },
        "PreferredHeight":{
            "title":"Height",
            "type":"integer",
            "description":"The preferred height of the toolbar in pixels.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Height"
                },
                "precision":10
            },
            "x-queryable":true
        },
        "PreferredWidth":{
            "title":"Width",
            "type":"integer",
            "description":"The preferred width of the toolbar in pixels.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Width"
                },
                "precision":10
            },
            "x-queryable":true
        },
        "SupportedChannels":{
            "title":"Supported Channels",
            "maxLength":200,
            "type":"string",
            "description":"The comma delimited list of channel types supported by the toolbar.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Supported Channels"
                }
            },
            "x-queryable":true
        },
        "ToolbarEnabledProfile":{
            "type":"string",
            "description":"The profile value for SVC_PARTNER_MEDIA_TOOLBAR_ENABLED profile name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToolbarId":{
            "title":"Toolbar ID",
            "type":"integer",
            "description":"The auto-generated number and primary key for the toolbar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Toolbar ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "ToolbarLabel":{
            "maxLength":64,
            "type":"string",
            "description":"The user friendly label for the toolbar.",
            "nullable":true,
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "maxLength":500,
            "type":"string",
            "description":"The URL for the toolbar rendering.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"URL"
                }
            },
            "x-queryable":true
        },
        "UrlValidDomainName":{
            "maxLength":200,
            "type":"string",
            "description":"The domain name for optional redirection.",
            "nullable":true,
            "x-queryable":true
        },
        "Vendor":{
            "maxLength":64,
            "type":"string",
            "description":"The optional field for the name of the vendor.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Multi-Channel Adapter Toolbar Additions

Type: array

Title: Multi-Channel Adapter Toolbar Additions

The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.

Show Source

• Array of: object multiChannelAdapterToolbars-McaToolbarAddition-item-response

{
    "title":"Multi-Channel Adapter Toolbar Additions",
    "type":"array",
    "description":"The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.",
    "items":{
        "$ref":"#/components/schemas/multiChannelAdapterToolbars-McaToolbarAddition-item-response"
    }
}

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."
        }
    }
}

Nested Schema : multiChannelAdapterToolbars-McaToolbarAddition-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the additional toolbar is available for use.
• AdditionalTlbType: string
  Title: Additional Toolbar Type

  Maximum Length: 30

  The type of additional toolbar being configured.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the additional toolbar.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the additional toolbar was created.
• DefaultVisibleFlag: boolean
  Title: Default Visible

  Maximum Length: 1

  Default Value: true

  Indicates whether the additional toolbar should be visible by default.
• LastUpdateDate: string (date-time)
  Read Only: true

  The user who last updated the additional toolbar.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The date when the additional toolbar was last updated.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the additional toolbar.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PreferredHeight: integer (int64)
  Title: Height

  The preferred height of the additional toolbar in pixels.
• PreferredWidth: integer (int64)
  Title: Width

  The preferred width of the additional toolbar in pixels.
• ToolbarAddlId: integer (int64)
  Title: Additional Toolbar ID

  Read Only: true

  The auto-generated number and primary key for the additional toolbar.
• ToolbarId: integer (int64)
  Title: Toolbar ID

  The foreign key to the parent toolbar
• ToolbarLabel: string
  Maximum Length: 25

  The user friendly label for the additional toolbar.
• Url: string
  Title: URL

  Maximum Length: 500

  The URL for the additional toolbar rendering.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the additional toolbar is available for use.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "help":{
                    "instruction":"Active"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTlbType":{
            "title":"Additional Toolbar Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of additional toolbar being configured.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Additional Toolbar Type"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the additional toolbar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the additional toolbar was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultVisibleFlag":{
            "title":"Default Visible",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the additional toolbar should be visible by default.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "help":{
                    "instruction":"Default Visible"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the additional toolbar.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the additional toolbar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date when the additional toolbar was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredHeight":{
            "title":"Height",
            "type":"integer",
            "description":"The preferred height of the additional toolbar in pixels.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Height"
                },
                "precision":10
            },
            "x-queryable":true
        },
        "PreferredWidth":{
            "title":"Width",
            "type":"integer",
            "description":"The preferred width of the additional toolbar in pixels.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Width"
                },
                "precision":10
            },
            "x-queryable":true
        },
        "ToolbarAddlId":{
            "title":"Additional Toolbar ID",
            "type":"integer",
            "description":"The auto-generated number and primary key for the additional toolbar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Additional Toolbar ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "ToolbarId":{
            "title":"Toolbar ID",
            "type":"integer",
            "description":"The foreign key to the parent toolbar",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ToolbarLabel":{
            "maxLength":25,
            "type":"string",
            "description":"The user friendly label for the additional toolbar.",
            "nullable":true,
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "maxLength":500,
            "type":"string",
            "description":"The URL for the additional toolbar rendering.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"URL"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

McaToolbarAddition

Operation: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition

Parameters:

• ToolbarId: $request.path.ToolbarId

The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.

OrientationLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MCA_TOOLBAR_ORIENT_CD

The following properties are defined on the LOV link relation:

• Source Attribute: Orientation; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top