Jump to

• Request
• Response

Create an event

post

/crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents

Request

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

• AgentId: integer (int64)
  The agent identifier from the parties entity.
• ApplClassificationCd: string
  Maximum Length: 32

  The code of the application classification to which this event applies.
• BoEntityId: integer (int64)
  The auto-generated number and primary key for the business object entity table.
• ChannelId: integer (int64)
  The auto-generated number and primary key of the channels table.
• CommId: string
  Maximum Length: 64

  The communication ID represented by the API Event ID.
• ContactId: integer (int64)
  The auto-generated number and primary key for the contact table.
• DirectionCd: string
  Maximum Length: 32

  The direction of the event for the token values.
• ErrorMsg: string
  Maximum Length: 4000

  The error message of the event processing.
• ErrorMsgCd: string
  Maximum Length: 64

  The error code for the event processing.
• InteractionId: integer (int64)
  The auto-generated number and primary key for the interactions table.
• InTokens: string
  Maximum Length: 4000

  The input tokens of the request payload.
• McaEventNumber: string
  Maximum Length: 30

  The public surrogate key which is required during creation of the row.
• Method: string
  Maximum Length: 32

  The name of the calling event method.
• NextState: string
  Maximum Length: 32

  The next state calculated by the event processing.
• ObjectVersionNumber: integer (int32)
  The object version number is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• Origin: string
  Maximum Length: 250

  The URL representing the event initiator.
• OutTokens: string
  Maximum Length: 4000

  The output tokens in the response payload.
• Result: string
  Maximum Length: 64

  The returned result of event processing.
• ToolbarId: integer (int64)
  The auto-generated number and primary key for the toolbars table.
• ToolbarName: string
  Maximum Length: 64

  The toolbar name being used for this event.
• Uuid: string
  Maximum Length: 64

  Client response unique identifier.
• Version: string
  Maximum Length: 32

  The version of the client side consumer.
• WindowName: string
  Maximum Length: 64

  The client window identifier of the event.
• WrapupId: integer (int64)
  The auto-generated number and primary key for the wrap ups table.

{
    "type":"object",
    "properties":{
        "AgentId":{
            "type":"integer",
            "description":"The agent identifier from the parties entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ApplClassificationCd":{
            "maxLength":32,
            "type":"string",
            "description":"The code of the application classification to which this event applies.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BoEntityId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the business object entity table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ChannelId":{
            "type":"integer",
            "description":"The auto-generated number and primary key of the channels table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CommId":{
            "maxLength":64,
            "type":"string",
            "description":"The communication ID represented by the API Event ID.",
            "nullable":false
        },
        "ContactId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the contact table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DirectionCd":{
            "maxLength":32,
            "type":"string",
            "description":"The direction of the event for the token values.",
            "nullable":false
        },
        "ErrorMsg":{
            "maxLength":4000,
            "type":"string",
            "description":"The error message of the event processing.",
            "nullable":true
        },
        "ErrorMsgCd":{
            "maxLength":64,
            "type":"string",
            "description":"The error code for the event processing.",
            "nullable":true
        },
        "InTokens":{
            "maxLength":4000,
            "type":"string",
            "description":"The input tokens of the request payload.",
            "nullable":true
        },
        "InteractionId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the interactions table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "McaEventNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public surrogate key which is required during creation of the row.",
            "nullable":false
        },
        "Method":{
            "maxLength":32,
            "type":"string",
            "description":"The name of the calling event method.",
            "nullable":false
        },
        "NextState":{
            "maxLength":32,
            "type":"string",
            "description":"The next state calculated by the event processing.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Origin":{
            "maxLength":250,
            "type":"string",
            "description":"The URL representing the event initiator.",
            "nullable":true
        },
        "OutTokens":{
            "maxLength":4000,
            "type":"string",
            "description":"The output tokens in the response payload.",
            "nullable":true
        },
        "Result":{
            "maxLength":64,
            "type":"string",
            "description":"The returned result of event processing.",
            "nullable":true
        },
        "ToolbarId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the toolbars table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ToolbarName":{
            "maxLength":64,
            "type":"string",
            "description":"The toolbar name being used for this event.",
            "nullable":true
        },
        "Uuid":{
            "maxLength":64,
            "type":"string",
            "description":"Client response unique identifier.",
            "nullable":true
        },
        "Version":{
            "maxLength":32,
            "type":"string",
            "description":"The version of the client side consumer.",
            "nullable":false
        },
        "WindowName":{
            "maxLength":64,
            "type":"string",
            "description":"The client window identifier of the event.",
            "nullable":true
        },
        "WrapupId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the wrap ups table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• AgentId: integer (int64)
  The agent identifier from the parties entity.
• ApplClassificationCd: string
  Maximum Length: 32

  The code of the application classification to which this event applies.
• BoEntityId: integer (int64)
  The auto-generated number and primary key for the business object entity table.
• ChannelId: integer (int64)
  The auto-generated number and primary key of the channels table.
• CommId: string
  Maximum Length: 64

  The communication ID represented by the API Event ID.
• ContactId: integer (int64)
  The auto-generated number and primary key for the contact table.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the event was created.
• DirectionCd: string
  Maximum Length: 32

  The direction of the event for the token values.
• EntityName: string
  Title: Object Name

  Read Only: true

  Maximum Length: 64

  A unique identifier of the business object entity.
• ErrorMsg: string
  Maximum Length: 4000

  The error message of the event processing.
• ErrorMsgCd: string
  Maximum Length: 64

  The error code for the event processing.
• InteractionId: integer (int64)
  The auto-generated number and primary key for the interactions table.
• InTokens: string
  Maximum Length: 4000

  The input tokens of the request payload.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• McaEventId: integer (int64)
  Read Only: true

  The auto-generated number and primary key for the event.
• McaEventNumber: string
  Maximum Length: 30

  The public surrogate key which is required during creation of the row.
• Method: string
  Maximum Length: 32

  The name of the calling event method.
• NextState: string
  Maximum Length: 32

  The next state calculated by the event processing.
• ObjectVersionNumber: integer (int32)
  The object version number is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• Origin: string
  Maximum Length: 250

  The URL representing the event initiator.
• OutTokens: string
  Maximum Length: 4000

  The output tokens in the response payload.
• Result: string
  Maximum Length: 64

  The returned result of event processing.
• ToolbarId: integer (int64)
  The auto-generated number and primary key for the toolbars table.
• ToolbarName: string
  Maximum Length: 64

  The toolbar name being used for this event.
• Uuid: string
  Maximum Length: 64

  Client response unique identifier.
• Version: string
  Maximum Length: 32

  The version of the client side consumer.
• WindowName: string
  Maximum Length: 64

  The client window identifier of the event.
• WrapupId: integer (int64)
  The auto-generated number and primary key for the wrap ups table.

{
    "type":"object",
    "properties":{
        "AgentId":{
            "type":"integer",
            "description":"The agent identifier from the parties entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplClassificationCd":{
            "maxLength":32,
            "type":"string",
            "description":"The code of the application classification to which this event applies.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BoEntityId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the business object entity table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelId":{
            "type":"integer",
            "description":"The auto-generated number and primary key of the channels table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CommId":{
            "maxLength":64,
            "type":"string",
            "description":"The communication ID represented by the API Event ID.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the contact table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectionCd":{
            "maxLength":32,
            "type":"string",
            "description":"The direction of the event for the token values.",
            "nullable":false,
            "x-queryable":true
        },
        "EntityName":{
            "title":"Object Name",
            "maxLength":64,
            "type":"string",
            "description":"A unique identifier of the business object entity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Object Name"
                }
            },
            "x-queryable":true
        },
        "ErrorMsg":{
            "maxLength":4000,
            "type":"string",
            "description":"The error message of the event processing.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMsgCd":{
            "maxLength":64,
            "type":"string",
            "description":"The error code for the event processing.",
            "nullable":true,
            "x-queryable":true
        },
        "InTokens":{
            "maxLength":4000,
            "type":"string",
            "description":"The input tokens of the request payload.",
            "nullable":true,
            "x-queryable":true
        },
        "InteractionId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the interactions table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the event.",
            "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 event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date when the event was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "McaEventId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "McaEventNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public surrogate key which is required during creation of the row.",
            "nullable":false,
            "x-queryable":true
        },
        "Method":{
            "maxLength":32,
            "type":"string",
            "description":"The name of the calling event method.",
            "nullable":false,
            "x-queryable":true
        },
        "NextState":{
            "maxLength":32,
            "type":"string",
            "description":"The next state calculated by the event processing.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Origin":{
            "maxLength":250,
            "type":"string",
            "description":"The URL representing the event initiator.",
            "nullable":true,
            "x-queryable":true
        },
        "OutTokens":{
            "maxLength":4000,
            "type":"string",
            "description":"The output tokens in the response payload.",
            "nullable":true,
            "x-queryable":true
        },
        "Result":{
            "maxLength":64,
            "type":"string",
            "description":"The returned result of event processing.",
            "nullable":true,
            "x-queryable":true
        },
        "ToolbarId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the toolbars table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ToolbarName":{
            "maxLength":64,
            "type":"string",
            "description":"The toolbar name being used for this event.",
            "nullable":true,
            "x-queryable":true
        },
        "Uuid":{
            "maxLength":64,
            "type":"string",
            "description":"Client response unique identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "Version":{
            "maxLength":32,
            "type":"string",
            "description":"The version of the client side consumer.",
            "nullable":false,
            "x-queryable":true
        },
        "WindowName":{
            "maxLength":64,
            "type":"string",
            "description":"The client window identifier of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "WrapupId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the wrap ups table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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

ApplClassificationCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MCA_APPL_CLASSIF_CD

The following properties are defined on the LOV link relation:

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

Back to Top