Dow Jones Client Delete API

openapi: 3.2.0
info:
  title: Advanced Screening and Monitoring Client Delete API
  description: 'Dow Jones


    ### Rate limits


    Most endpoints are subject to a general rate limit of 10,000 requests per user per 15 minutes.


    Some endpoints are also subject to a global concurrent request limit of 5 simultaneous requests per customer.'
  version: '3'
  license: {}
  contact: {}
servers:
- url: API_INSTANCE
security:
- basicAuth: []
- jwt: []
- clientCert: []
tags:
- name: Client Delete
  description: The Client Delete endpoint allows clients to hard delete client records in the system.
paths:
  /client/delete:
    post:
      summary: Delete client records
      operationId: deleteClientRecords
      description: 'Provide a list of client ids to be deleted.

        ### Rate Limits


        This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.

        '
      tags:
      - Client Delete
      parameters:
      - name: formData
        required: true
        in: header
        schema:
          type: file
          description: 'CSV file containing a single column: Client ID


            Containing a list of client ids to mark for deletion.

            '
      responses:
        '200':
          description: The delete client request was successfully submitted. The response body contains details of the newly-create client load job's ID and status.
          content:
            application/json:
              schema:
                type: object
                description: The status of the client delete job.
                properties:
                  id:
                    type: integer
                    description: The unique identifier id for your deletion request
                  type:
                    type: string
                    description: the job type.
                  state:
                    type: string
                    description: The state your deletion request is in
                    enum:
                    - queued
                    - running
                    - completed
                    - errored
                  clientKey:
                    type: string
                    description: Client key for multi-tenant systems
                  metadata:
                    type: object
                  user:
                    type: object
                  time:
                    type: object
                  namespace:
                    type: string
                  tags:
                    type: array
        '401':
          description: Unauthorized
        '403':
          description: Forbidden (e.g. the user does not have the correct permission)
        '404':
          description: Not Found - the specificed client delete job does not exist.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                required:
                - code
                - message
                properties:
                  code:
                    type: string
                    description: Error code that can be used when contacting support or looking up information
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                  status:
                    type: number
                    description: HTTP Error code
  /client/delete/{jobId}/errors:
    get:
      summary: Client delete job errors
      operationId: clientDeleteJobErrors
      description: 'Retreive the errors associated with a given client delete job. Results are returned in pages, defined using the `from` and `to` query parameters.

        ### Rate Limits


        This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.

        '
      tags:
      - Client Delete
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: number
        description: The ID of the client delete job.
      - name: skip
        in: query
        required: false
        schema:
          type: number
        description: Number of jobs to skip ahead.
      - name: limit
        in: query
        required: false
        schema:
          type: number
          default: 20
      responses:
        '200':
          description: The details of any errors or warnings associated with the client delete job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                        message:
                          type: string
                        code:
                          type: integer
                          description: 'An error code indicating the nature of the error:

                            * 1 : Invalid client relationship

                            * 2 : Invalid JSON

                            * 3 : Missing attribute

                            * 4 : Failed to stage the client

                            * 5 : Invalid attribute specified on the client

                            * 6 : Invalid data format (JSON/CSV)

                            * 7 : Client failed during assessment

                            * 100  : Unexpected exception

                            '
                        details:
                          type: object
                          properties:
                            clientId:
                              type: string
                            from:
                              type: string
                            to:
                              type: string
                            missingClientId:
                              type: string
                            lineNumber:
                              type: integer
                              example: 1
                            additionalInformation:
                              type: string
                              example: Missing required 'objectType' attribute
                            lineContent:
                              type: string
                              example: '{"profileId":"another-id-007","name":"John Smith",...}'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden (e.g. the user does not have the correct permission)
        '404':
          description: Not Found - the specificed client delete job does not exist.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                required:
                - code
                - message
                properties:
                  code:
                    type: string
                    description: Error code that can be used when contacting support or looking up information
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                  status:
                    type: number
                    description: HTTP Error code
  /client/delete/filter:
    post:
      summary: Client delete filter
      operationId: clientDeleteReportFilter
      description: 'Retrieve the Client Delete jobs created by all users.

        ### Rate Limits


        This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.

        '
      tags:
      - Client Delete
      responses:
        '200':
          description: The response to indicate the request was successful. Returns an array of jobs.
          content:
            application/json:
              schema:
                type: array
                description: The current state of the delete jobs the user has requested.
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: The unique identifier id for your deletion request
                    state:
                      type: string
                      description: The state your deletion request is in
                      enum:
                      - queued
                      - running
                      - completed
                      - errored
                    metadata:
                      type: object
                    time:
                      type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden (e.g. the user does not have the correct permission)
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                required:
                - code
                - message
                properties:
                  code:
                    type: string
                    description: Error code that can be used when contacting support or looking up information
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                  status:
                    type: number
                    description: HTTP Error code
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT authentication is the preferred authentication method, and should be used for new integrations.  Contact support to request a service account.
    basicAuth:
      type: http
      scheme: basic
      description: Basic authentication is supported for existing users, but is deprecated.  Existing users are encouraged to contact support for a dedicated service account and switch to JWT authentication.