Adobe Suite Profile System Jobs API

openapi: 3.2.0
info:
  title: Real-time Customer Profile Profile System Jobs API
  description: Use Real-time Customer Profile to drive coordinated, consistent and relevant experiences for your customers no matter where or when they interact with your brand.
  version: '1.0'
servers:
- url: https://{environment}.adobe.io/data/core
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: Profile System Jobs
  description: Profile System Jobs allow you to delete profile fragments for a given dataset or batch. For more information on using this set of endpoints, please read the profile system jobs endpoint guide.
paths:
  /ups/system/jobs:
    get:
      tags:
      - Profile System Jobs
      summary: List all delete requests (Profile System Jobs)
      description: Please note that the query parameters can **only** be used in Microsoft Azure instances of Adobe Experience Platform. To learn more about the supported Experience Platform infrastructure, see the Experience Platform multi-cloud overview.
      operationId: listDeleteRequests
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: x-sandbox-id
        in: header
        description: The ID of the sandbox you are using. If you are using Platform on Amazon Web Services (AWS), you **must** use this request header.
        schema:
          type: string
      - name: start
        in: query
        description: Return results from a specific page offset. For example, `start=3`
        schema:
          type: integer
      - name: limit
        in: query
        description: Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`
        schema:
          type: integer
      - name: page
        in: query
        description: Return a specific page of results, as per the create time of the request. For example, `page=0`
        schema:
          type: integer
      - name: sort
        in: query
        description: Sort results by a specific field in ascending (`asc`) or descending (`desc`) order. The sort parameter does not work when returning multiple pages of results. For example, `sort=batchId:asc`
        schema:
          type: string
      responses:
        200:
          x-summary: Success
          description: Returns a list of all delete requests (Profile System Jobs) defined by your organization.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProfileSystemJobsResponse'
                - $ref: '#/components/schemas/ListAWSSystemJobs'
              examples:
                Microsoft Azure:
                  value:
                    _page:
                      count: 100
                      next: K1JJRDpFaWc5QUwyZFgtMEpBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQVFBQWZBQUg0Ly9yL25PcmpmZndEZUR3QT0
                    children:
                    - id: 9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4
                      imsOrgId: '{ORG_ID}'
                      batchId: 8d075b5a178e48389126b9289dcfd0ac
                      jobType: DELETE
                      status: COMPLETED
                      metrics: '{"recordsProcessed":5,"timeTakenInSec":1}'
                      createEpoch: 1559026134
                      updateEpoch: 1559026137
                    - id: 3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec
                      imsOrgId: '{ORG_ID}'
                      dataSetId: 5c802d3cd83fc114b741c4b5
                      jobType: DELETE
                      status: PROCESSING
                      metrics: '{"recordsProcessed":0,"timeTakenInSec":15}'
                      createEpoch: 1559025404
                      updateEpoch: 1559025406
                Amazon Web Services (AWS):
                  value:
                  - requestId: 80a9405a-21ca-4278-aedf-99367f90c055
                    requestType: DELETE_EE_BATCH
                    imsOrgId: '{ORG_ID}'
                    sandbox:
                      sandboxName: prod
                      sandboxId: 8129954b-fa83-43ba-a995-4bfa8373ba2b
                    status: SUCCESS
                    properties:
                      batchId: 01JFSYFDFW9JAAEKHX672JMPSB
                      datasetId: 66a92c5910df2d1767de13f3
                    createdAt: '2024-12-23T15:55:34.905411Z'
                    updatedAt: '2024-12-23T15:58:56.917088Z'
                  - requestId: 38a835eb-b491-4864-902b-be07fa4d6a6d
                    requestType: TRUNCATE_DATASET
                    imsOrgId: '{ORG_ID}'
                    sandbox:
                      sandboxName: prod
                      sandboxId: 8129954b-fa83-43ba-a995-4bfa8373ba2b
                    status: SUCCESS
                    properties:
                      datasetId: 66a92c5910df2d1767de13f3
                    createdAt: '2024-12-22T19:44:50.250006Z'
                    updatedAt: '2024-12-22T19:52:13.380706Z'
        '403':
          x-summary: Missing access permissions
          description: You do not have access permissions for this endpoint.
          content: {}
        '500':
          x-summary: Internal server error
          description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
          content: {}
        503:
          x-summary: Service unavailable
          description: Service Unavailable
          content: {}
    post:
      tags:
      - Profile System Jobs
      summary: Create delete request (Profile System Job)
      description: 'Initiating a new delete request is done through a POST request to the `/systems/jobs` endpoint, where the ID of the dataset or batch to be deleted is provided in the body of the request.


        In order to delete a dataset, the dataset ID must be included in the body of the POST request. This action will delete **ALL** data for a given dataset. Experience Platform allows you to delete datasets based on both record and time series schemas.


        In order to delete a batch, the batch ID must be included in the body of the POST request. Please be advised that you cannot delete batches for datasets based on record schemas. Only batches for datasets based on time series schemas may be deleted.


        **Note:** The reason you cannot delete batches for datasets based on record schemas is because record type dataset batches overwrite previous records and therefore cannot be "undone" or deleted. The way to remove the impact of erroneous batches for datasets based on record schemas is to re-ingest the batch with the correct data and it will overwrite the incorrect records.


        For more information on record and time series behavior, please review the section on XDM data behaviors in the XDM System overview.'
      operationId: createDeleteRequest
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: x-sandbox-id
        in: header
        description: The ID of the sandbox you are using. If you are using Platform on Amazon Web Services (AWS), you **must** use this request header.
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Type of content being sent in the body of the request. Should be 'application/json'.
        required: true
        schema:
          type: string
      requestBody:
        description: "A JSON object containing the ID of the dataset or batch to be deleted.\n**Example for batch ID:**\n<pre>{\n  \"batchId\": \"8d075b5a178e48389126b9289dcfd0ac\"\n}</pre>"
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XdmDataJobPostBodyWithDataSetId'
        required: true
      responses:
        200:
          x-summary: Success
          description: Delete request (Profile System Job) successfully created
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProfileSystemJob'
                - $ref: '#/components/schemas/AWSSystemJob'
              examples:
                Microsoft Azure:
                  value:
                    id: 3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec
                    imsOrgId: '{ORG_ID}'
                    dataSetId: 5c802d3cd83fc114b741c4b5
                    jobType: DELETE
                    status: NEW
                    createEpoch: 1559025404
                    updateEpoch: 1559025406
                Amazon Web Services (AWS):
                  value:
                    requestId: 80a9405a-21ca-4278-aedf-99367f90c055"
                    requestType: DELETE_EE_BATCH
                    imsOrgId: '{ORG_ID}'
                    sandbox:
                      sandboxName: prod
                      sandboxId: 8129954b-fa83-43ba-a995-4bfa8373ba2b
                    status: NEW
                    properties:
                      batchId: 01JFSYFDFW9JAAEKHX672JMPSB
                      datasetId: 66a92c5910df2d1767de13f3
                    createdAt: '2024-12-22T19:44:50.250006Z'
                    updatedAt: '2024-12-22T19:44:50.250006Z'
        400:
          x-summary: Invalid
          description: Invalid delete request (Profile System Job)
          content: {}
        '403':
          x-summary: Missing access permissions
          description: You do not have access permissions for this endpoint.
          content: {}
        422:
          x-summary: Request already exists
          description: Delete request (Profile System Job) Definition already exists.
          content: {}
        '500':
          x-summary: Internal server error
          description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
          content: {}
        503:
          x-summary: Service unavailable
          description: Service Unavailable
          content: {}
      x-codegen-request-body-name: body
  /ups/system/jobs/{ID}:
    get:
      tags:
      - Profile System Jobs
      summary: Retrieve a delete request (Profile System Job)
      operationId: retrieveDeleteRequest
      parameters:
      - name: ID
        in: path
        description: ID of the delete request (Profile System Job) that you wish to view. For example, '3e64ad31-5e6b-4399-80ad-ccfab54254ae'.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: x-sandbox-id
        in: header
        description: The ID of the sandbox you are using. If you are using Platform on Amazon Web Services (AWS), you **must** use this request header.
        schema:
          type: string
      responses:
        200:
          x-summary: Success
          description: Returns the details of a specific delete request (Profile System Job).
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ProfileSystemJob'
                - $ref: '#/components/schemas/AWSSystemJob'
              examples:
                Microsoft Azure:
                  value:
                    id: 9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4
                    imsOrgId: '{ORG_ID}'
                    batchId: 8d075b5a178e48389126b9289dcfd0ac
                    jobType: DELETE
                    status: COMPLETED
                    metrics: '{"recordsProcessed":5,"timeTakenInSec":1}'
                    createEpoch: 1559026134
                    updateEpoch: 1559026137
                Amazon Web Services (AWS):
                  value:
                    requestId: 9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4
                    requestType: DELETE_EE_BATCH
                    imsOrgId: '{ORG_ID}'
                    sandbox:
                      sandboxName: prod
                      sandboxId: 8129954b-fa83-43ba-a995-4bfa8373ba2b
                    status: SUCCESS
                    properties:
                      batchId: 01JFSYFDFW9JAAEKHX672JMPSB
                      datasetId: 66a92c5910df2d1767de13f3
                    createdAt: '2024-12-22T19:44:50.250006Z'
                    updatedAt: '2024-12-22T19:52:13.380706Z'
        '403':
          x-summary: Missing access permissions
          description: You do not have access permissions for this endpoint.
          content: {}
        404:
          x-summary: Not found
          description: Delete request (Profile System Job) not found
          content: {}
        '500':
          x-summary: Internal server error
          description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
          content: {}
        503:
          x-summary: Service unavailable
          description: Service Unavailable
          content: {}
    delete:
      tags:
      - Profile System Jobs
      summary: Remove a delete request (Profile System Job)
      description: This endpoint can **only** be used with the Microsoft Azure instance of Adobe Experience Platform, and **cannot** be used with the Amazon Web Services (AWS) instance of Platform.
      operationId: deleteDeleteRequest
      parameters:
      - name: ID
        in: path
        description: ID of the delete request (Profile System Job) that you wish to view. For example, '3e64ad31-5e6b-4399-80ad-ccfab54254ae'.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      responses:
        200:
          x-summary: Success
          description: If removal is successful, returns HTTP Status 200 (OK) and an empty response body.
          content: {}
        '403':
          x-summary: Missing access permissions
          description: You do not have access permissions for this endpoint.
          content: {}
        404:
          x-summary: Not found
          description: Delete request (Profile System Job) not found
          content: {}
        503:
          x-summary: Service unavailable
          description: Service Unavailable
          content: {}
components:
  schemas:
    XdmDataJobPostBodyWithDataSetId:
      type: object
      properties:
        dataSetId:
          type: string
          description: dataSetId
          example: 5cf212ed73fbff145365d15d
    AWSSystemJob:
      type: object
      properties:
        requestId:
          type: string
          description: The ID of the system job when using Platform on AWS.
          example: 80a9405a-21ca-4278-aedf-99367f90c055
        requestType:
          type: string
          description: The type of system job.
          example: DELETE_EE_BATCH
          enum:
          - BACKFILL_TTL
          - DELETE_EE_BATCH
          - TRUNCATE_DATASET
        imsOrgId:
          type: string
          description: The ID of the organization the system job belongs to.
          example: '{ORG_ID}'
        sandbox:
          type: object
          description: The sandbox that the system job belongs to.
          properties:
            sandboxName:
              type: string
              example: prod
              description: The name of the sandbox.
            sandboxId:
              type: string
              description: The ID of the sandbox.
              example: 8129954b-fa83-43ba-a995-4bfa8373ba2b
        status:
          type: string
          example: SUCCESS
          description: The status of the system job.
          enum:
          - NEW
          - SUCCESS
          - ERROR
          - FAILED
          - IN-PROGRESS
        properties:
          type: object
          description: An object that contains batch and/or dataset IDs for the system job.
          properties:
            batchId:
              type: string
              description: The ID of the batch you want to delete.
              example: 01JFSYFDFW9JAAEKHX672JMPSB
            datasetId:
              type: string
              description: The ID of the dataset you want to delete.
              example: 66a92c5910df2d1767de13f3
        createdAt:
          type: string
          description: A timestamp that shows when the system job was created.
          example: '2024-12-23T15:55:34.905411Z'
        updatedAt:
          type: string
          description: A timestamp that shows when the system job was last updated.
          example: '2024-12-23T15:58:56.917088Z'
    SystemJobsPage:
      required:
      - count
      type: object
      properties:
        count:
          type: number
          description: number of ProfileSystemJobsDefinition per page
          example: 100.0
        next:
          type: string
          description: page offset
          example: K1JJRDpFaWc5QUwyZFgtMEpBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQVFBQWZBQUg0Ly9yL25PcmpmZndEZUR3QT0=
    ListAWSSystemJobs:
      type: array
      items:
        type: object
        $ref: '#/components/schemas/AWSSystemJob'
    ProfileSystemJobsResponse:
      type: object
      properties:
        _page:
          $ref: '#/components/schemas/SystemJobsPage'
        children:
          type: array
          items:
            $ref: '#/components/schemas/ProfileSystemJob'
    ProfileSystemJob:
      type: object
      properties:
        id:
          type: string
          description: ProfileSystemJob or delete request ID
          example: 9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4
        imsOrgId:
          type: string
          description: The ID of the organization.
          example: '{ORG_ID}'
        dataSetId:
          type: string
          description: dataset Id
          example: 5cf212ed73fbff145365d15d
        batchId:
          type: string
          description: batch Id
          example: 5cf212ed73fbff145365d15d
        jobType:
          type: string
          description: Type of Profile System Job
          example: DELETE
        status:
          type: string
          description: Status of Profile System Job
          example: NEW
          enum:
          - NEW
          - PROCESSING
          - COMPLETED
          - ERROR
        metrics:
          type: string
          description: Rum time metrics of Profile System Job
          example: '{\"recordsProcessed\":727109,\"timeTakenInSec\":50}'
        createEpoch:
          type: integer
          description: create timestamp
          example: 1234567890
        updateEpoch:
          type: integer
          description: update timestamp
          example: 1234567890
  parameters:
    x-api-key:
      name: x-api-key
      in: header
      description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
    authorization:
      name: Authorization
      in: header
      description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
    x-sandbox-name:
      name: x-sandbox-name
      in: header
      description: All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.
      required: true
      schema:
        type: string
    x-gw-ims-org-id:
      name: x-gw-ims-org-id
      in: header
      description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string