Get details for async process

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

Path Parameters

asyncProcessesUuid string required

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
uuid string
status string

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

asyncTaskType string

Possible values: [CREATE_DEALER, UPDATE_DEALER_PRODUCTS]

name string
startTime string
endTime string
taskDetails 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]
]
serviceSubscriber object
name string
uuid string
business object
type string
Possible values: [DEALER, PRODUCT]
uuid string
name string
requesterUser object
type string
Possible values: [ADMIN_USER, MYKAARMA_USER, EXTERNAL_USER]
name string
uuid string

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

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"
}

GET /v2/async-processes/:asyncProcessesUuid

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

asyncProcessesUuid — path required

curl / cURL

curl -L -X GET '/manage/v2/async-processes/:asyncProcessesUuid' \
-H 'Accept: application/json'

python / requests

curl -L -X GET '/manage/v2/async-processes/:asyncProcessesUuid' \
-H 'Accept: application/json'

go / native

curl -L -X GET '/manage/v2/async-processes/:asyncProcessesUuid' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET '/manage/v2/async-processes/:asyncProcessesUuid' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET '/manage/v2/async-processes/:asyncProcessesUuid' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET '/manage/v2/async-processes/:asyncProcessesUuid' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET '/manage/v2/async-processes/:asyncProcessesUuid' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET '/manage/v2/async-processes/:asyncProcessesUuid' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET '/manage/v2/async-processes/:asyncProcessesUuid' \
-H 'Accept: application/json'