> ## Documentation Index > Fetch the complete documentation index at: https://docs.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # List built component operations > Returns all component operations as they appear on the built component. ## OpenAPI ````yaml /api-reference/management.json get /v1/components/{component_id}/operations/built openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. ## Updating a resource `PUT` merges. A field you omit from the body is left at its stored value, so you do not need to read a resource and send it back whole in order to change one field. This is a deliberate departure from the HTTP convention that `PUT` replaces, and it holds across this API. Two qualifications, both visible on each operation's own request schema: - Some operations mark fields `required` in their request schema. Those must be sent on every request, whether or not you are changing them. - A field that holds a list or a map is replaced, not merged, when you supply it. Sending one entry of a collection stores that entry and drops the rest, so to change one member of a collection you must send the collection's other members alongside it. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Batch Jobs (Legacy) - name: Blocks - name: Campaigns - name: Components - name: Components Operations - name: Domains - name: Email - name: Erasure - name: Event Streams - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: SFTP Servers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v1/components/{component_id}/operations/built: get: tags: - Components Operations summary: List built component operations description: Returns all component operations as they appear on the built component. parameters: - in: path name: component_id required: true schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BuiltComponentOperationResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' component_not_found: $ref: '#/components/examples/component_not_found' component_operation_parameter_invalid: $ref: '#/components/examples/component_operation_parameter_invalid' component_operation_path_malformed: $ref: '#/components/examples/component_operation_path_malformed' component_operation_path_missing: $ref: '#/components/examples/component_operation_path_missing' component_operation_schema_invalid: $ref: '#/components/examples/component_operation_schema_invalid' component_operation_schema_too_large: $ref: '#/components/examples/component_operation_schema_too_large' component_owner_not_supported: $ref: '#/components/examples/component_owner_not_supported' component_state_not_supported: $ref: '#/components/examples/component_state_not_supported' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' invalid_incoming_url: $ref: '#/components/examples/invalid_incoming_url' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_setting_filter: $ref: '#/components/examples/invalid_setting_filter' invalid_uri_in_json: $ref: '#/components/examples/invalid_uri_in_json' missing_request_body: $ref: '#/components/examples/missing_request_body' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' settings_build_failed: $ref: '#/components/examples/settings_build_failed' unknown_source_clients: $ref: '#/components/examples/unknown_source_clients' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: BuiltComponentOperationResponse: properties: consumes: description: The media types the request body may use. items: enum: - APPLICATION_FORM_URLENCODED - APPLICATION_JSON - APPLICATION_OCTET_STREAM - MULTIPART_FORM_DATA - TEXT_CSV - TEXT_HTML - TEXT_JAVASCRIPT - TEXT_PLAIN type: string type: array description: description: Explanation of what the operation does, already evaluated. type: string display_name: description: Human-readable label for the operation, already evaluated. type: string method: description: HTTP method of the operation. enum: - DELETE - GET - PATCH - POST - PUT type: string name: description: Unique name of the operation within its component. type: string openapi_spec: $ref: '#/components/schemas/JsonNode' parameters: description: >- The path, query, header and cookie parameters the operation accepts, each with the values it accepts. items: $ref: '#/components/schemas/ComponentOperationParameter' type: array path: description: >- Path of the operation, for example `/v5/persons/{person_id}`. The host is derived from the operation type: `api.extole.io` for SERVER_TO_EXTOLE, or the default program domain of the client for CONSUMER_TO_EXTOLE. type: string priority: $ref: '#/components/schemas/DeweyDecimal' produces: description: The media types the response can carry. items: enum: - APPLICATION_FORM_URLENCODED - APPLICATION_JSON - APPLICATION_OCTET_STREAM - MULTIPART_FORM_DATA - TEXT_CSV - TEXT_HTML - TEXT_JAVASCRIPT - TEXT_PLAIN type: string type: array request_schema: $ref: '#/components/schemas/JsonNode' response_schema: $ref: '#/components/schemas/JsonNode' tags: description: >- Freeform labels used for grouping, including category such as ACTION or VIEW. items: description: >- Freeform labels used for grouping, including category such as ACTION or VIEW. type: string type: array uniqueItems: true type: description: Which Extole API this operation belongs to. Dictates authentication. enum: - CONSUMER_TO_EXTOLE - SERVER_TO_EXTOLE type: string required: - consumes - description - display_name - method - name - openapi_spec - parameters - path - priority - produces - request_schema - response_schema - tags - type type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object JsonNode: type: object ComponentOperationParameter: description: >- A parameter a component operation's path carries, and the values it accepts. properties: description: description: What the parameter means to the caller. nullable: true type: string name: description: The placeholder or query key the operation's path carries. type: string required: description: >- Whether the caller must send the parameter. A `PATH` parameter is always required. type: boolean type: description: Where in the path the caller puts the parameter. enum: - PATH - QUERY type: string value_schema: $ref: '#/components/schemas/ComponentOperationParameterSchema' type: object DeweyDecimal: example: '10' type: string ComponentOperationParameterSchema: description: The values a component operation parameter accepts. properties: default_value: description: The value Extole uses when the caller sends none. nullable: true type: string format: description: A format refining the type, such as `date-time` or `uuid`. nullable: true type: string items: $ref: '#/components/schemas/ComponentOperationParameterSchema' type: description: The JSON type the parameter carries. Defaults to STRING. enum: - ARRAY - BOOLEAN - INTEGER - NUMBER - OBJECT - STRING type: string values: description: >- The only values the parameter accepts. An empty list leaves the parameter free text. items: type: string type: array type: object examples: binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_build_failed: summary: campaign_build_failed value: code: campaign_build_failed http_status_code: 400 message: Campaign build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_not_found: summary: campaign_component_not_found value: code: campaign_component_not_found http_status_code: 400 message: Campaign Component not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_not_found: summary: component_not_found value: code: component_not_found http_status_code: 400 message: Component not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_parameter_invalid: summary: component_operation_parameter_invalid value: code: component_operation_parameter_invalid http_status_code: 400 message: Component operation parameter is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_path_malformed: summary: component_operation_path_malformed value: code: component_operation_path_malformed http_status_code: 400 message: Component operation path is malformed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_path_missing: summary: component_operation_path_missing value: code: component_operation_path_missing http_status_code: 400 message: Component operation path is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_schema_invalid: summary: component_operation_schema_invalid value: code: component_operation_schema_invalid http_status_code: 400 message: >- Component operation schema is not a valid JSON Schema draft 2020-12 document parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_schema_too_large: summary: component_operation_schema_too_large value: code: component_operation_schema_too_large http_status_code: 400 message: Component operation schema serialized length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_owner_not_supported: summary: component_owner_not_supported value: code: component_owner_not_supported http_status_code: 400 message: Component owner not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_state_not_supported: summary: component_state_not_supported value: code: component_state_not_supported http_status_code: 400 message: Component state not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 controller_state_misconfiguration: summary: controller_state_misconfiguration value: code: controller_state_misconfiguration http_status_code: 400 message: A controller has not properly configured state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 expression_invalid_syntax: summary: expression_invalid_syntax value: code: expression_invalid_syntax http_status_code: 400 message: Campaign build failed due expression invalid syntax parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_incoming_url: summary: invalid_incoming_url value: code: invalid_incoming_url http_status_code: 400 message: Incoming URL is an invalid URI parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_setting_filter: summary: invalid_setting_filter value: code: invalid_setting_filter http_status_code: 400 message: >- Invalid setting filter, expected format: name:value; backslash escapes the next character (e.g. \, \: \\) parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_uri_in_json: summary: invalid_uri_in_json value: code: invalid_uri_in_json http_status_code: 400 message: Invalid URI in JSON parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 rebuild_campaigns_build_failed: summary: rebuild_campaigns_build_failed value: code: rebuild_campaigns_build_failed http_status_code: 400 message: Rebuild campaigns build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 settings_build_failed: summary: settings_build_failed value: code: settings_build_failed http_status_code: 400 message: Component settings build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unknown_source_clients: summary: unknown_source_clients value: code: unknown_source_clients http_status_code: 400 message: Some source client ids are unknown parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ```` ## Related topics - [Get a built component operation](/api-reference/components-operations/get-a-built-component-operation.md) - [List built components](/api-reference/components/list-built-components.md) - [List component operations](/api-reference/components-operations/list-component-operations.md) - [List built component assets](/api-reference/components/list-built-component-assets.md) - [List built component settings](/api-reference/components/list-built-component-settings.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.