Get list of all async processes

ApiScope: manage.async.process.read
API Scope Level: ServiceSubscriberScope

application/json

Request Body required

page int32
pageSize int32
taskTypes string[]

Possible values: [CREATE_DEALER, UPDATE_DEALER_PRODUCTS]

taskStatuses string[]

Possible values: [NOT_STARTED, COMPLETED, FAILED, IN_PROGRESS, NOT_NEEDED]

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
asyncTaskVisibleList object[]
Array [
uuid string
asyncTaskType string
Possible values: [CREATE_DEALER, UPDATE_DEALER_PRODUCTS]
name string
taskDetails string
startTime string
endTime string
status string
Possible values: [NOT_STARTED, COMPLETED, FAILED, IN_PROGRESS, NOT_NEEDED]
requesterUserName string
serviceSubscriber string
steps object[]
Array [
uuid string
order int32
key string
detail string
name string
startTime string
endTime string
status string
Possible values: [NOT_STARTED, COMPLETED, FAILED, IN_PROGRESS, NOT_NEEDED]
]
]
totalCount int32

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "asyncTaskVisibleList": [
    {
      "uuid": "string",
      "asyncTaskType": "CREATE_DEALER",
      "name": "string",
      "taskDetails": "string",
      "startTime": "string",
      "endTime": "string",
      "status": "NOT_STARTED",
      "requesterUserName": "string",
      "serviceSubscriber": "string",
      "steps": [
        {
          "uuid": "string",
          "order": 0,
          "key": "string",
          "detail": "string",
          "name": "string",
          "startTime": "string",
          "endTime": "string",
          "status": "NOT_STARTED"
        }
      ]
    }
  ],
  "totalCount": 0
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

POST /v2/async-processes/searches

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

Body required

{
  "page": 0,
  "pageSize": 0,
  "taskTypes": [
    "CREATE_DEALER"
  ],
  "taskStatuses": [
    "NOT_STARTED"
  ]
}

curl / cURL

curl -L -X POST '/manage/v2/async-processes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "page": 0,
  "pageSize": 0,
  "taskTypes": [
    "CREATE_DEALER"
  ],
  "taskStatuses": [
    "NOT_STARTED"
  ]
}'

python / requests

curl -L -X POST '/manage/v2/async-processes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "page": 0,
  "pageSize": 0,
  "taskTypes": [
    "CREATE_DEALER"
  ],
  "taskStatuses": [
    "NOT_STARTED"
  ]
}'

go / native

curl -L -X POST '/manage/v2/async-processes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "page": 0,
  "pageSize": 0,
  "taskTypes": [
    "CREATE_DEALER"
  ],
  "taskStatuses": [
    "NOT_STARTED"
  ]
}'

nodejs / axios

curl -L -X POST '/manage/v2/async-processes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "page": 0,
  "pageSize": 0,
  "taskTypes": [
    "CREATE_DEALER"
  ],
  "taskStatuses": [
    "NOT_STARTED"
  ]
}'

ruby / Net::HTTP

curl -L -X POST '/manage/v2/async-processes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "page": 0,
  "pageSize": 0,
  "taskTypes": [
    "CREATE_DEALER"
  ],
  "taskStatuses": [
    "NOT_STARTED"
  ]
}'

csharp / RestSharp

curl -L -X POST '/manage/v2/async-processes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "page": 0,
  "pageSize": 0,
  "taskTypes": [
    "CREATE_DEALER"
  ],
  "taskStatuses": [
    "NOT_STARTED"
  ]
}'

php / cURL

curl -L -X POST '/manage/v2/async-processes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "page": 0,
  "pageSize": 0,
  "taskTypes": [
    "CREATE_DEALER"
  ],
  "taskStatuses": [
    "NOT_STARTED"
  ]
}'

java / OkHttp

curl -L -X POST '/manage/v2/async-processes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "page": 0,
  "pageSize": 0,
  "taskTypes": [
    "CREATE_DEALER"
  ],
  "taskStatuses": [
    "NOT_STARTED"
  ]
}'

powershell / RestMethod

curl -L -X POST '/manage/v2/async-processes/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "page": 0,
  "pageSize": 0,
  "taskTypes": [
    "CREATE_DEALER"
  ],
  "taskStatuses": [
    "NOT_STARTED"
  ]
}'