Jump to

• Request
• Response

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: 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.
• Upsert-Mode: string
  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

Request Body - application/json ()

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

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

ActiveFlagLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

DefaultVisibleLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

ToolbarTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

Back to Top