Jump to

• Request
• Response

Update a collaboration action attribute

patch

/crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/child/actionAttributes/{AttribId}

Request

Path Parameters

• AttribId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• CollabActionNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• AttribName: string
  Title: Attribute Name

  Maximum Length: 64

  The business object attribute name associated with the collaboration action.
• ChannelId: integer (int64)
  Title: Channel ID

  The channel associated with the action attribute.
• CollabActionId: integer (int64)
  Title: Action ID

  The unique identifier of the collaboration action associated with the attribute.
• ContextAttribFlag: boolean
  Title: Business Object Identifier

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is used as the context attribute for passing to and from the collaboration network and CX Sales.
• ControlTypeCd: string
  Title: User Interface Component

  Maximum Length: 30

  The UI controls used to display the attributes on the collaboration network such as List or Text box.
• DataSource: string
  Title: End Point

  Maximum Length: 4000

  The API to get the a list of values for an attribute of type list.
• DataSourceLabelAttrib: string
  Title: Option Label

  Maximum Length: 64

  The API attribute used as the display value of the action attribute. This applies to action attributes with control type as List.
• DataSourceValueAttrib: string
  Title: Option Value

  Maximum Length: 64

  The API attribute used to save the selected action attribute value. This applies to action attributes with control type as List.
• DataTypeCd: string
  Title: Data Type

  Maximum Length: 30

  The data type of collaboration action attributes such as Date Time or Number.
• DeepLink: string
  Title: Deep Link

  Maximum Length: 1000

  A deep link URL format that links to the object associated with the action attribute.
• DefaultValue: string
  Title: Default Value

  Maximum Length: 4000

  The default value of the action attribute.
• DisplayName: string
  Title: Display Name

  Maximum Length: 64

  The label of the action attribute displayed when displaying the attribute in the collaboration network.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The display order of the action attribute.
• RequestAttribFlag: boolean
  Title: Included in Request

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is part of the request payload.
• ResponseAttribFlag: boolean
  Title: Included in Response

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is part of the response payload.

{
    "type":"object",
    "properties":{
        "AttribName":{
            "title":"Attribute Name",
            "maxLength":64,
            "type":"string",
            "description":"The business object attribute name associated with the collaboration action.",
            "nullable":false
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The channel associated with the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CollabActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the collaboration action associated with the attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContextAttribFlag":{
            "title":"Business Object Identifier",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the action attribute is used as the context attribute for passing to and from the collaboration network and CX Sales.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ControlTypeCd":{
            "title":"User Interface Component",
            "maxLength":30,
            "type":"string",
            "description":"The UI controls used to display the attributes on the collaboration network such as List or Text box.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DataSource":{
            "title":"End Point",
            "maxLength":4000,
            "type":"string",
            "description":"The API to get the a list of values for an attribute of type list.",
            "nullable":true
        },
        "DataSourceLabelAttrib":{
            "title":"Option Label",
            "maxLength":64,
            "type":"string",
            "description":"The API attribute used as the display value of the action attribute. This applies to action attributes with control type as List.",
            "nullable":true
        },
        "DataSourceValueAttrib":{
            "title":"Option Value",
            "maxLength":64,
            "type":"string",
            "description":"The API attribute used to save the selected action attribute value. This applies to action attributes with control type as List.",
            "nullable":true
        },
        "DataTypeCd":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The data type of collaboration action attributes such as Date Time or Number.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeepLink":{
            "title":"Deep Link",
            "maxLength":1000,
            "type":"string",
            "description":"A deep link URL format that links to the object associated with the action attribute.",
            "nullable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":4000,
            "type":"string",
            "description":"The default value of the action attribute.",
            "nullable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":64,
            "type":"string",
            "description":"The label of the action attribute displayed when displaying the attribute in the collaboration network.",
            "nullable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display order of the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RequestAttribFlag":{
            "title":"Included in Request",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the action attribute is part of the request payload.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResponseAttribFlag":{
            "title":"Included in Response",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the action attribute is part of the response payload.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : collaborationActions-actionAttributes-item-response

Type: object

Show Source

• AttribId: integer (int64)
  Title: Attribute ID

  Read Only: true

  The unique identifier of the action attribute.
• AttribName: string
  Title: Attribute Name

  Maximum Length: 64

  The business object attribute name associated with the collaboration action.
• ChannelId: integer (int64)
  Title: Channel ID

  The channel associated with the action attribute.
• CollabActionId: integer (int64)
  Title: Action ID

  The unique identifier of the collaboration action associated with the attribute.
• ContextAttribFlag: boolean
  Title: Business Object Identifier

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is used as the context attribute for passing to and from the collaboration network and CX Sales.
• ControlTypeCd: string
  Title: User Interface Component

  Maximum Length: 30

  The UI controls used to display the attributes on the collaboration network such as List or Text box.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the action attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the action attribute was created.
• DataSource: string
  Title: End Point

  Maximum Length: 4000

  The API to get the a list of values for an attribute of type list.
• DataSourceLabelAttrib: string
  Title: Option Label

  Maximum Length: 64

  The API attribute used as the display value of the action attribute. This applies to action attributes with control type as List.
• DataSourceValueAttrib: string
  Title: Option Value

  Maximum Length: 64

  The API attribute used to save the selected action attribute value. This applies to action attributes with control type as List.
• DataTypeCd: string
  Title: Data Type

  Maximum Length: 30

  The data type of collaboration action attributes such as Date Time or Number.
• DeepLink: string
  Title: Deep Link

  Maximum Length: 1000

  A deep link URL format that links to the object associated with the action attribute.
• DefaultValue: string
  Title: Default Value

  Maximum Length: 4000

  The default value of the action attribute.
• DisplayName: string
  Title: Display Name

  Maximum Length: 64

  The label of the action attribute displayed when displaying the attribute in the collaboration network.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The display order of the action attribute.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the action attribute was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the action attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the action attributes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAttribFlag: boolean
  Title: Included in Request

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is part of the request payload.
• ResponseAttribFlag: boolean
  Title: Included in Response

  Maximum Length: 1

  Default Value: false

  Indicates if the action attribute is part of the response payload.

{
    "type":"object",
    "properties":{
        "AttribId":{
            "title":"Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the action attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttribName":{
            "title":"Attribute Name",
            "maxLength":64,
            "type":"string",
            "description":"The business object attribute name associated with the collaboration action.",
            "nullable":false,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The channel associated with the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollabActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the collaboration action associated with the attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContextAttribFlag":{
            "title":"Business Object Identifier",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the action attribute is used as the context attribute for passing to and from the collaboration network and CX Sales.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ControlTypeCd":{
            "title":"User Interface Component",
            "maxLength":30,
            "type":"string",
            "description":"The UI controls used to display the attributes on the collaboration network such as List or Text box.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the action attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSource":{
            "title":"End Point",
            "maxLength":4000,
            "type":"string",
            "description":"The API to get the a list of values for an attribute of type list.",
            "nullable":true,
            "x-queryable":true
        },
        "DataSourceLabelAttrib":{
            "title":"Option Label",
            "maxLength":64,
            "type":"string",
            "description":"The API attribute used as the display value of the action attribute. This applies to action attributes with control type as List.",
            "nullable":true,
            "x-queryable":true
        },
        "DataSourceValueAttrib":{
            "title":"Option Value",
            "maxLength":64,
            "type":"string",
            "description":"The API attribute used to save the selected action attribute value. This applies to action attributes with control type as List.",
            "nullable":true,
            "x-queryable":true
        },
        "DataTypeCd":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The data type of collaboration action attributes such as Date Time or Number.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeepLink":{
            "title":"Deep Link",
            "maxLength":1000,
            "type":"string",
            "description":"A deep link URL format that links to the object associated with the action attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":4000,
            "type":"string",
            "description":"The default value of the action attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":64,
            "type":"string",
            "description":"The label of the action attribute displayed when displaying the attribute in the collaboration network.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display order of the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the action attribute was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the action attributes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestAttribFlag":{
            "title":"Included in Request",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the action attribute is part of the request payload.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResponseAttribFlag":{
            "title":"Included in Response",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the action attribute is part of the response payload.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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

ControlTypeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_ATT_CON_TYPE_CD

The following properties are defined on the LOV link relation:

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

DataTypeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_DATA_TYPE_CD

The following properties are defined on the LOV link relation:

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

Back to Top