Create all toolbar additions
post
/crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition
Request
Path Parameters
-
ToolbarId(required): integer(int64)
The auto-generated number and primary key for the toolbar.
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:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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.
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.
Root 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
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.
Links
- ActiveFlagLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: ActiveFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- DefaultVisibleLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: DefaultVisibleFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ToolbarTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MCA_ADDL_TLB_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: AdditionalTlbType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: