Get all toolbars
get
/crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- AltKey_Name: Finds the toolbar of the specified alternate key value.
Finder Variables:- DisplayName; string; The alternate key which is unique for this toolbar.
- FindMyToolbar: Finds a single row of the current user's default toolbar.
Finder Variables: - PrimaryKey: Finds the toolbar of the specified primary key value.
Finder Variables:- ToolbarId; integer; The unique identifier of the toolbar primary key.
- AltKey_Name: Finds the toolbar of the specified alternate key value.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveFlag; boolean; Indicates whether the toolbar is available for use.
- CreatedBy; string; The user who created the toolbar.
- CreationDate; string; The date and time when the toolbar was created.
- DefaultVisibleFlag; boolean; Indicates whether the toolbar should be visible by default
- DisplayName; string; The user friendly name of the toolbar.
- LastUpdateDate; string; The user who last updated the toolbar.
- LastUpdateLogin; string; The login of the user who last updated the toolbar.
- LastUpdatedBy; string; The date when the toolbar was last updated.
- Layout; string; The user friendly description of the layout.
- LwAcceptOnFlag; boolean; Indicates the Accept/Reject dialog should be shown in Live Window for incoming engagements from this toolbar.
- Name; string; The name of the toolbar.
- Orientation; string; The orientation of the toolbar. Either HORIZONTAL or VERTICAL
- OverrideToolbarProfile; string; The profile value for SVC_OVERRIDE_PARTNER_TOOLBAR_SELECTION profile name.
- PreferredHeight; integer; The preferred height of the toolbar in pixels.
- PreferredWidth; integer; The preferred width of the toolbar in pixels.
- SupportedChannels; string; The comma delimited list of channel types supported by the toolbar.
- ToolbarEnabledProfile; string; The profile value for SVC_PARTNER_MEDIA_TOOLBAR_ENABLED profile name.
- ToolbarId; integer; The auto-generated number and primary key for the toolbar.
- ToolbarLabel; string; The user friendly label for the toolbar.
- Url; string; The URL for the toolbar rendering.
- UrlValidDomainName; string; The domain name for optional redirection.
- Vendor; string; The optional field for the name of the vendor.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 TopResponse
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.
Root Schema : multiChannelAdapterToolbars
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : multiChannelAdapterToolbars-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : multiChannelAdapterToolbars-McaToolbarAddition-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source