Skip to main content
GET
Get a component operation

Authorizations

Authorization
string
header
required

Path Parameters

component_id
string
required
operation_name
string
required

Response

Successful response

Stored component operation definition. Fields display_name, description, request_schema, response_schema, path, and method are unevaluated and appear in buildtime-evaluatable form.

description
required

Explanation of what the operation does. Buildtime expressions use CampaignBuildtimeContext.

display_name
required

Human-readable label for the operation, shown in authoring surfaces. Buildtime expressions use CampaignBuildtimeContext.

method
required

HTTP method of the operation. Buildtime evaluatable. Buildtime expressions use CampaignBuildtimeContext.

Available options:
DELETE,
GET,
PATCH,
POST,
PUT
name
string
required

Unique name of the operation within its component. Lowercase letters, digits, underscores and dashes only.

path
required

Path of the operation, for example /v5/persons/{person_id}. The host is derived from the operation type and path: events.extole.io for SERVER_TO_EXTOLE on /v6/events, api.extole.io for SERVER_TO_EXTOLE on any other path, or the default program domain of the client for CONSUMER_TO_EXTOLE. Buildtime evaluatable. Buildtime expressions use CampaignBuildtimeContext.

priority
string
required
Example:

"10"

request_schema
required

The request schema as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use CampaignBuildtimeContext.

response_schema
required

The response schema as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use CampaignBuildtimeContext.

tags
string[]
required

Freeform labels used for grouping, including category such as ACTION or VIEW.

Freeform labels used for grouping, including category such as ACTION or VIEW.

type
enum<string>
required

Which Extole API this operation belongs to. Dictates authentication.

Available options:
CONSUMER_TO_EXTOLE,
SERVER_TO_EXTOLE