openapi: 3.0.0 info: title: Delphix DCT Algorithms JobOrchestrators API version: 3.28.0 description: Delphix DCT API contact: name: Delphix Support url: https://portal.perforce.com/s/ email: support@delphix.com servers: - url: /dct/v3 security: - ApiKeyAuth: [] tags: - name: JobOrchestrators paths: /job-orchestrators: post: tags: - JobOrchestrators summary: Create a job orchestrator. operationId: create_job_orchestrator requestBody: content: application/json: schema: x-body-name: job-orchestrators $ref: '#/components/schemas/CreateJobOrchestratorRequest' description: The parameters to create a job orchestrator required: true responses: '201': description: OK content: application/json: schema: type: object title: CreateJobOrchestratorResponse properties: id: type: string description: The ID of the created job orchestrator. job: $ref: '#/components/schemas/Job' description: The completed job. get: tags: - JobOrchestrators summary: Retrieve the list of job orchestrators. operationId: get_job_orchestrators parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/jobOrchestratorsSortParam' responses: '200': description: OK content: application/json: schema: type: object title: ListJobOrchestratorsResponse properties: items: type: array items: $ref: '#/components/schemas/JobOrchestrator' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /job-orchestrators/search: post: tags: - JobOrchestrators summary: Search job orchestrators. operationId: search_job_orchestrators x-filterable: fields: id: type: string name: type: string description: type: string creation_date: type: string account_id: type: integer account_name: type: string node_count: type: integer total_core_count: type: integer queued_operation_count: type: integer running_job_count: type: integer tags: type: array[object] fields: key: type: string value: type: string hyperscale_instance_id: type: string parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/jobOrchestratorsSortParam' requestBody: $ref: '#/components/requestBodies/SearchBody' responses: '200': description: OK content: application/json: schema: type: object title: SearchJobOrchestratorsResponse properties: items: type: array items: $ref: '#/components/schemas/JobOrchestrator' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /job-orchestrators/{jobOrchestratorId}: parameters: - $ref: '#/components/parameters/jobOrchestratorIdParam' get: tags: - JobOrchestrators summary: Retrieve a job orchestrator by ID. operationId: get_job_orchestrator_by_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/JobOrchestrator' patch: tags: - JobOrchestrators summary: Update a job orchestrator. operationId: update_job_orchestrator requestBody: content: application/json: schema: x-body-name: job-orchestrators $ref: '#/components/schemas/UpdateJobOrchestratorRequest' description: The parameters to update a job orchestrator required: true responses: '200': description: OK content: application/json: schema: type: object title: UpdateJobOrchestratorResponse properties: job: $ref: '#/components/schemas/Job' description: The completed job. delete: tags: - JobOrchestrators summary: Delete a job orchestrator. operationId: delete_job_orchestrator responses: '200': description: OK content: application/json: schema: type: object title: DeleteJobOrchestratorResponse properties: job: $ref: '#/components/schemas/Job' description: The completed job. /job-orchestrators/{jobOrchestratorId}/tags: parameters: - $ref: '#/components/parameters/jobOrchestratorIdParam' get: tags: - JobOrchestrators summary: Get tags for a job orchestrator. operationId: get_job_orchestrator_tags responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TagsResponse' post: tags: - JobOrchestrators summary: Create tags for a job orchestrator. operationId: create_job_orchestrator_tags requestBody: content: application/json: schema: x-body-name: job_orchestrator_tags $ref: '#/components/schemas/TagsRequest' description: Tags information for a job orchestrator. required: true responses: '201': description: Job orchestrator tags created content: application/json: schema: $ref: '#/components/schemas/TagsResponse' /job-orchestrators/{jobOrchestratorId}/tags/delete: parameters: - $ref: '#/components/parameters/jobOrchestratorIdParam' post: tags: - JobOrchestrators summary: Delete tags for a job orchestrator. operationId: delete_job_orchestrator_tags requestBody: $ref: '#/components/requestBodies/DeleteTags' responses: '204': description: No Content /job-orchestrators/{jobOrchestratorId}/application-settings: parameters: - $ref: '#/components/parameters/jobOrchestratorIdParam' get: tags: - JobOrchestrators summary: Returns a job orchestrator's application settings. operationId: get_job_orchestrator_application_settings parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/complianceApplicationSettingsSortParam' responses: '200': description: OK content: application/json: schema: type: object title: ComplianceApplicationSettingsListResponse properties: items: type: array items: $ref: '#/components/schemas/ComplianceApplicationSetting' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /job-orchestrators/{jobOrchestratorId}/application-settings/search: parameters: - $ref: '#/components/parameters/jobOrchestratorIdParam' post: tags: - JobOrchestrators summary: Search a job orchestrator's application settings. operationId: search_job_orchestrator_application_settings x-filterable: fields: id: type: string group: type: string name: type: string value: type: string value_type: type: string parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/complianceApplicationSettingsSortParam' requestBody: $ref: '#/components/requestBodies/SearchBody' responses: '200': description: OK content: application/json: schema: type: object title: ComplianceApplicationSettingsSearchResponse properties: items: type: array items: $ref: '#/components/schemas/ComplianceApplicationSetting' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /job-orchestrators/{jobOrchestratorId}/application-settings/{applicationSettingsId}: parameters: - $ref: '#/components/parameters/jobOrchestratorIdParam' - $ref: '#/components/parameters/applicationSettingsIdParam' put: tags: - JobOrchestrators summary: Update a job orchestrator's application setting value. operationId: update_job_orchestrator_application_setting requestBody: content: application/json: schema: x-body-name: application_setting_update_request $ref: '#/components/schemas/ComplianceApplicationSettingUpdateRequest' description: The application setting update request. required: true responses: '200': description: OK content: application/json: schema: type: object title: UpdateComplianceApplicationSettingResponse properties: job: $ref: '#/components/schemas/Job' /job-orchestrators/{jobOrchestratorId}/queued-operations: parameters: - $ref: '#/components/parameters/jobOrchestratorIdParam' get: tags: - JobOrchestrators summary: Returns a job orchestrator's queued operations. operationId: get_job_orchestrator_queued_operations parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/queuedOperationsSortParam' responses: '200': description: OK content: application/json: schema: type: object title: ListJobOrchestratorQueuedOperationsResponse properties: items: type: array items: $ref: '#/components/schemas/QueuedOperation' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /job-orchestrators/{jobOrchestratorId}/queued-operations/search: parameters: - $ref: '#/components/parameters/jobOrchestratorIdParam' post: tags: - JobOrchestrators summary: Search a job orchestrator's queued operations. operationId: search_job_orchestrator_queued_operations x-filterable: fields: id: type: string job_orchestrator_id: type: string enqueued_date: type: string job_type: type: string localized_job_type: type: string job_id: type: string target_id: type: string target_name: type: string target_type: type: string account_id: type: integer account_name: type: string parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/queuedOperationsSortParam' requestBody: $ref: '#/components/requestBodies/SearchBody' responses: '200': description: OK content: application/json: schema: type: object title: SearchJobOrchestratorQueuedOperationsResponse properties: items: type: array items: $ref: '#/components/schemas/QueuedOperation' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /job-orchestrators/{jobOrchestratorId}/support-bundle: parameters: - $ref: '#/components/parameters/jobOrchestratorIdParam' post: tags: - JobOrchestrators summary: Generates a bundle for requested nodes of a job orchestrator. operationId: generate_job_orchestrator_support_bundle requestBody: content: application/json: schema: type: object x-body-name: generate_support_bundle_request properties: target_node_ids: type: array description: List of node IDs to include in the support bundle. If empty, all nodes will be included. items: type: string required: false responses: '200': description: Registers a job to generate the support bundle. content: application/json: schema: type: object title: JobOrchestratorGenerateSupportBundleResponse properties: job: $ref: '#/components/schemas/Job' description: The Job tracking the support bundle generation. /job-orchestrators/{jobOrchestratorId}/move-to-hyperscale: parameters: - $ref: '#/components/parameters/jobOrchestratorIdParam' put: tags: - JobOrchestrators summary: Move compliance nodes from a job orchestrator to a hyperscale instance. operationId: move_compliance_nodes_to_hyperscale requestBody: content: application/json: schema: x-body-name: move_to_hyperscale_request $ref: '#/components/schemas/MoveComplianceNodesToHyperscaleRequest' description: The parameters to move compliance nodes to a hyperscale instance. required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MoveComplianceNodesResponse' components: schemas: JobOrchestrator: type: object description: A job orchestrator. properties: id: description: The Job Orchestrator entity ID. type: string readOnly: true example: 414ed52c-abed-455d-9fb9-9c2fa5115f80 name: type: string description: The name of the job orchestrator. example: My favorite Job Orchestrator description: type: string description: The description of the job orchestrator. example: Job Orchestrator for US-west creation_date: type: string readOnly: true description: The date this job orchestrator was created. format: date-time example: '2022-11-30T08:51:34.148000+00:00' account_id: description: The ID of the account who created this job orchestrator. type: integer format: int64 readOnly: true example: 1 account_name: description: The account name of the DCT user who created this job orchestrator. type: string example: username node_count: type: integer readOnly: true description: The number of compliance nodes registered with this Job Orchestrator that are not bound to a Hyperscale Instance. example: 10 total_core_count: type: integer readOnly: true description: The total number of cores across compliance nodes registered with this Job Orchestrator that are not bound to a Hyperscale Instance. example: 10 queued_operation_count: type: integer readOnly: true description: The number of operations currently queued on this job orchestrator. example: 10 running_job_count: type: integer readOnly: true description: The number of jobs currently running on this job orchestrator. example: 10 tags: description: The tags of this job orchestrator. type: array items: $ref: '#/components/schemas/Tag' hyperscale_instance_id: type: string readOnly: true description: The ID of the hyperscale instance associated with this job orchestrator if applicable. example: hyperscale-instance-123 Tag: type: object required: - key - value properties: key: description: Key of the tag type: string minLength: 1 maxLength: 4000 example: key-1 value: description: Value of the tag type: string minLength: 1 maxLength: 4000 example: value-1 MoveComplianceNodesToHyperscaleRequest: description: Parameters to move compliance nodes from a job orchestrator to a hyperscale orchestrator. type: object required: - compliance_node_ids - hyperscale_instance_id properties: compliance_node_ids: description: List of compliance node IDs to move. type: array items: type: string example: - node-101 - node-102 - node-103 hyperscale_instance_id: description: The ID of the target hyperscale instance to move the compliance nodes to. type: string example: f8e7d6c5-b4a3-2109-8765-43210fedcba9 VirtualizationTaskEvent: deprecated: true properties: message_details: type: string ComplianceApplicationSetting: title: ComplianceApplicationSetting type: object description: An application setting of a compliance engine. properties: id: description: The ID of the application setting. type: string example: 5835c60d-2155-1234-8c54-b4dff23d89c5 group: description: The group of the application setting. type: string example: general name: description: The name of the application setting. type: string example: PasswordResetLinkDuration value: description: The value of the application setting. type: string example: '5' value_type: description: The type of the value of the application setting. type: string enum: - string - number - boolean - regular-expression example: number QueuedOperation: description: A queued operation on a job orchestrator. type: object properties: id: description: The QueuedOperation entity ID. type: string example: queued-operation-123 job_orchestrator_id: description: The ID of the JobOrchestrator where the operation is queued. type: string example: f8e7d6c5-b4a3-2109-8765-43210fedcba9 enqueued_date: description: The date and time when the operation was enqueued. type: string format: date-time example: '2025-10-03T01:00:00.148000+00:00' job_type: description: The type of Job. type: string example: RULE_SET_REFRESH localized_job_type: description: The localized type of Job. type: string example: Rule Set Refresh job_id: description: The ID of the Job tracking this queued operation. type: string example: 414ed52c-fa89-455d-9fb9-9c2fa5115f80 target_id: description: A reference to the associated job's target. type: string example: rule-set-123 target_name: description: The associated job's target name. type: string example: my-rule-set target_type: description: The associated job's target object type. type: string example: RULE_SET account_id: description: The ID of the account who initiated this job. type: integer format: int64 readOnly: true example: 1 account_name: description: The account name of the DCT user who initiated this job. type: string readOnly: true example: John Doe Engine: properties: engine_id: type: string minLength: 1 maxLength: 4000 engine_name: type: string minLength: 1 maxLength: 4000 PaginatedResponseMetadata: type: object properties: prev_cursor: description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page. type: string next_cursor: description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page. type: string total: description: The total number of results. This value may not be provided. type: integer format: int_64 JobTaskEvent: properties: message_details: type: string DeleteTag: type: object properties: key: description: Key of the tag type: string minLength: 1 maxLength: 4000 example: key-1 value: description: Value of the tag type: string minLength: 1 maxLength: 4000 example: value-1 tags: description: List of tags to be deleted type: array minItems: 1 maxItems: 1000 uniqueItems: true items: $ref: '#/components/schemas/Tag' JobTask: properties: id: type: string parent_job_id: type: string start_time: type: string format: date-time end_time: type: string format: date-time title: type: string percent_complete: type: integer minimum: 0 maximum: 100 events: type: array items: $ref: '#/components/schemas/JobTaskEvent' status: type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED TagsRequest: type: object required: - tags properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' minItems: 1 maxItems: 1000 uniqueItems: true MoveComplianceNodesResponse: description: Response for compliance node movement operations. type: object properties: job: $ref: '#/components/schemas/Job' description: The Job tracking the compliance node movement. UpdateJobOrchestratorRequest: type: object description: Parameters to update a job orchestrator. properties: name: type: string description: The name of the job orchestrator. example: My favorite Job Orchestrator description: type: string description: The description of the job orchestrator. example: Job Orchestrator for US-west SearchBody: description: Search body. type: object properties: filter_expression: type: string minLength: 5 maxLength: 50000 example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku" VirtualizationTask: deprecated: true properties: id: type: string parent_job_id: type: string start_time: type: string format: date-time end_time: type: string format: date-time title: type: string percent_complete: type: integer minimum: 0 maximum: 100 events: type: array items: $ref: '#/components/schemas/VirtualizationTaskEvent' status: type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED ComplianceApplicationSettingUpdateRequest: title: ComplianceApplicationSettingUpdateRequest type: object description: Request to update an application setting value. required: - setting_value properties: setting_value: description: The new value for the application setting. type: string example: '10' TagsResponse: type: object properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' CreateJobOrchestratorRequest: type: object description: Parameters to create a job orchestrator. required: - name properties: name: type: string description: The name of the job orchestrator. example: My favorite Job Orchestrator description: type: string description: The description of the job orchestrator. example: Job Orchestrator for US-west tags: description: The tags to be created for this compliance job collection. type: array items: $ref: '#/components/schemas/Tag' make_current_account_owner: type: boolean default: true description: Whether the account creating this Job Orchestrator must be configured as its owner. Job: description: An asynchronous task. type: object properties: id: description: The Job entity ID. type: string example: job-123 status: description: The status of the job. type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED example: RUNNING is_waiting_for_telemetry: description: Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated. type: boolean type: description: The type of job being done. type: string example: DB_REFRESH localized_type: description: The i18n translated type of job being done. type: string example: DB Refresh error_details: description: Details about the failure for FAILED jobs. type: string example: Unable to connect to the engine. warning_message: description: Warnings for the job. type: string example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.' target_id: description: A reference to the job's target. type: string example: vdb-123 target_name: description: A reference to the job's target name. type: string example: vdb start_time: description: The time the job started executing. type: string format: date-time example: '2022-01-02T05:11:24.148000+00:00' update_time: description: The time the job was last updated. type: string format: date-time example: '2022-01-02T06:11:24.148000+00:00' trace_id: description: traceId of the request which created this Job type: string engine_ids: description: IDs of the engines this Job is executing on. type: array items: type: string deprecated: true tags: type: array items: $ref: '#/components/schemas/Tag' engines: type: array items: $ref: '#/components/schemas/Engine' account_id: description: The ID of the account who initiated this job. type: integer example: 1 account_name: description: The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-. type: string example: User 1 compliance_node_id: type: string description: The ID of the associated compliance node, if applicable. nullable: true compliance_node_name: type: string description: The name of the associated compliance node, if applicable. nullable: true percent_complete: description: Completion percentage of the Job. type: integer minimum: 0 maximum: 100 example: '50' virtualization_tasks: deprecated: true type: array items: $ref: '#/components/schemas/VirtualizationTask' tasks: type: array items: $ref: '#/components/schemas/JobTask' execution_id: description: The ID of the associated masking execution, if any. type: string nullable: true result_type: description: The type of the job result. This is the type of the object present in the result. type: string result: description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property. type: object parameters: jobOrchestratorIdParam: in: path name: jobOrchestratorId schema: type: string minLength: 1 required: true description: The ID of the job orchestrator. limit: name: limit in: query description: Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. example: 50 schema: type: integer minimum: 1 maximum: 1000 default: 100 jobOrchestratorsSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies a descending order. example: id required: false schema: type: string enum: - id - -id - name - -name - description - -description - creation_date - -creation_date - account_id - -account_id - account_name - -account_name - node_count - -node_count - total_core_count - -total_core_count - queued_operation_count - -queued_operation_count - running_job_count - -running_job_count nullable: true example: name cursor: name: cursor in: query description: Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. schema: type: string minLength: 1 maxLength: 4096 applicationSettingsIdParam: in: path name: applicationSettingsId schema: type: string minLength: 1 required: true description: The ID of the application setting. queuedOperationsSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: group required: false schema: type: string enum: - id - -id - job_orchestrator_id - -job_orchestrator_id - enqueued_date - -enqueued_date - job_type - -job_type - localized_job_type - -localized_job_type - job_id - -job_id - target_id - -target_id - target_name - -target_name - target_type - -target_type - account_id - -account_id - account_name - -account_name nullable: true complianceApplicationSettingsSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: group required: false schema: type: string enum: - id - -id - group - -group - name - -name - value - -value - value_type - -value_type nullable: true requestBodies: SearchBody: x-skip-codegen-attr: description description: 'A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS ''foobar'', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN [''Goku'', ''Vegeta''] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH ''12''` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ ''Goku'' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ ''Goku'' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS ''foo'') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", ''foo'', ''bar'', ''foo bar'' | | Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], [''foo'', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. ' content: application/json: schema: $ref: '#/components/schemas/SearchBody' examples: nested: description: 'An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0. ' summary: Nested Object Comparison value: filter_expression: repositories CONTAINS {version eq '19.0.0'} relative: description: 'An example of a relative comparison testing that field1 has a value which is less than 123. ' summary: Relative comparison value: filter_expression: field1 LE 123 nil: description: 'An example of using nil to test for the absence of a value for field2. ' summary: Absence of an attribute value value: filter_expression: field2 EQ NIL non-nil: description: 'An example of using nil to test for the existence of a value for field2. ' summary: Existence of an attribute value value: filter_expression: field2 NE NIL contains: description: 'An example of using the ''CONTAINS'' operator to check if field2 contains the string ''foo''. If field2 is string valued then this is checking if ''foo'' is a substring of field2. If field2 is a list of strings then this is checking if ''foo'' is a member of the list. ' summary: Use of the CONTAINS operator value: filter_expression: field2 CONTAINS 'foo' in: description: 'An example of using the ''IN'' operator to check if field1 is an element of a list literal. ' summary: Use of the IN operator value: filter_expression: field1 IN [1, 2, 3] search: description: 'An example of using the ''SEARCH'' operator to retrieve all elements for which ''foo'' is a substring of a filterable attribute. ' summary: Use of the SEARCH operator value: filter_expression: SEARCH 'foo' parenthesis: description: 'An example of parenthesis being used to group operators & override operator precedence. ' summary: Overriding operator precedence value: filter_expression: field1 LT 1234 AND (field2 CONTAINS 'foo' OR field3 CONTAINS 'bar') DeleteTags: description: The parameters to delete tags content: application/json: schema: x-body-name: environment $ref: '#/components/schemas/DeleteTag' examples: delete_all_tags: description: Delete all tags for given object - No request body required summary: Delete all tags value: {} delete_tags_by_key: description: Delete all tags for given object with matching key summary: Delete tags by key value: key: key-1 delete_tags_by_key_value: description: Delete tag for given object with matching key and value summary: Delete a tag by key & value value: key: key-1 value: value-1 delete_multiple_tags_by_key_value: description: Delete tags for given list of tags with matching key and value summary: Delete multiple tags by key & value value: tags: - key: key-1 value: value-1 - key: key-2 value: value-2 securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization