find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/alianza-bulk-operation-job-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Alianza Bulk Operation Job API
  version: '2'
  description: 'Operations tagged Bulk Operation Job across 2 of this provider''s published API definitions: alianza-bulk-operation-job-api-openapi.yml, alianza-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.d2.alianza.com
  description: Development
- url: https://api.q2.alianza.com
  description: QA
- url: https://api.b2.alianza.com
  description: Beta
- url: https://api.alianza.com
  description: Production
security:
- X-Auth-Token: []
tags:
- name: Bulk Operation Job
  description: Manage jobs used in the bulk process.
paths:
  /v2/bulk-user-operation/job:
    servers:
    - url: https://api.d2.alianza.com
      description: Development
    - url: https://api.q2.alianza.com
      description: QA
    - url: https://api.b2.alianza.com
      description: Beta
    - url: https://api.alianza.com
      description: Production
    post:
      tags:
      - Bulk Operation Job
      summary: Create new job
      description: Create a new job. This endpoint can take two content types -- application/json and multipart/form-data. Please see the request body examples for the content type you will be using.
      operationId: create_job
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobDTO'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/JobFormDTO'
            examples:
              jobRequest:
                $ref: '#/components/examples/CreateJobExample'
        required: true
      responses:
        '200':
          description: Job created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDTO'
        '400':
          description: Invalid job details supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationErrorResponse'
        '403':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationErrorResponse'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationErrorResponse'
  /v2/bulk-user-operation/job/{jobId}:
    servers:
    - url: https://api.d2.alianza.com
      description: Development
    - url: https://api.q2.alianza.com
      description: QA
    - url: https://api.b2.alianza.com
      description: Beta
    - url: https://api.alianza.com
      description: Production
    get:
      tags:
      - Bulk Operation Job
      summary: Get job details
      description: Get job details by ID
      operationId: get_job
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Job retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDTO'
        '403':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationErrorResponse'
        '404':
          description: Job not found; Invalid JobId
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationErrorResponse'
    put:
      tags:
      - Bulk Operation Job
      summary: Update existing job
      description: Update an existing job
      operationId: update_job
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobDTO'
        required: true
      responses:
        '200':
          description: Job updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDTO'
        '400':
          description: Invalid job details supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationErrorResponse'
        '403':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationErrorResponse'
        '404':
          description: Job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationErrorResponse'
components:
  schemas:
    BulkOperationErrorResponse:
      type: object
      properties:
        status:
          type: integer
          description: HTTP error status code
        message:
          type: string
          description: Detailed error message
        errors:
          type: array
          description: list of errors
          items:
            type: string
          example:
          - transformObjectsFile must not be null
          - jobTypeId should be valid
          - etc.
        schemaErrors:
          type: array
          description: list of schema errors
          items:
            type: object
          example:
          - index: index (location) of the error
            path: path
            description: description of the schema error
    JobFormDTO:
      type: object
      properties:
        transformObjectType:
          type: string
          enum:
          - CreateUserInput
          - CreateTelephoneNumberInput
          - DeleteUserInput
          - DeleteTelephoneNumberInput
        transformObjectFile:
          type: string
          format: binary
          description: valid data file that corresponds to the transform object type definition
        targetAccountId:
          type: string
          description: account that this data will go into
        jobTypeId:
          type: string
          enum:
          - create users
          - create telephone numbers
          - delete users
          - delete telephone numbers
      required:
      - transformObjectType
      - transformObjectFile
      - targetAccountId
      - jobTypeId
    JobOutputCollectionDTO:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the output collection
      required:
      - id
    JobStatusDTO:
      type: string
      enum:
      - CREATED
      - STARTED
      - ABORTED
      - COMPLETED
    JobDTO:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the job
        ownerId:
          type: string
          description: Owner identifier of the job
        jobTypeId:
          type: string
          description: Type identifier of the job
          example: create users | delete users | create telephone numbers | delete telephone numbers
        targetAccountId:
          type: string
          description: Target account identifier for the job
          example: '456'
        inputCollectionId:
          type: string
          description: Input collection identifier for the job
          example: '789'
        jobStatus:
          $ref: '#/components/schemas/JobStatusDTO'
        executionStatus:
          $ref: '#/components/schemas/JobStatusDTO'
        updatedDateTime:
          type: string
          format: date-time
          description: Timestamp of the last update in ISO 8601 format
        outputCollections:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/JobOutputCollectionDTO'
        abortAfter:
          type: integer
          description: Time after which the job should be aborted
      required:
      - jobTypeId
      - targetAccountId
      - inputCollectionId
  examples:
    CreateJobExample:
      summary: Create a Job (multipart/form-data)
      value:
        transformObjectType: CreateUserInput
        transformObjectFile: <file to upload>
        targetAccountId: 0123948534
        jobTypeId: create users
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      in: header
      name: X-AUTH-TOKEN
x-refined-from:
- alianza-bulk-operation-job-api-openapi.yml
- alianza-openapi-original.yml