Get asynchronous request

This API call will return information about the specified asynchronous request.

Apart from basic information about the asynchronous operation such as who created it and for what action, the response will contain a subset of Get project information.

The response contains an asyncResponse field which will remain null until the async request has finished processing. If any errors occurred during processing of the request, this field will contain such errors or warnings.

The action field identifies the type of operation. Common values relevant to the job workflow:

• IMPORT_JOB — job file import, returned by Create job
• PRE_TRANSLATE — pre-translation run, returned by Pre-translate job

Note: It is important to keep track of the number of pending asynchronous requests as these are subject to Phrase limits.

GET /api2/v1/async/{asyncRequestId}

Get asynchronous request

cURL

curl --request GET \
  --url https://cloud.memsource.com/web/api2/v1/async/{asyncRequestId} \
  --header 'Authorization: <api-key>'

200

{
  "asyncResponse": {
    "acceptedSegmentsCount": 123,
    "dateCreated": "2023-11-07T05:31:56Z",
    "errorCode": "<string>",
    "errorDesc": "<string>",
    "errorDetails": [
      {
        "args": {},
        "code": "<string>",
        "message": "<string>"
      }
    ],
    "warnings": [
      {
        "args": {},
        "code": "<string>",
        "message": "<string>"
      }
    ]
  },
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "uid": "<string>",
    "userName": "<string>"
  },
  "dateCreated": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "parent": "<unknown>",
  "project": {
    "name": "<string>",
    "uid": "<string>"
  }
}

Authorizations

ApiTokenOAuth2

Authorization · string · header · required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Path Parameters

asyncRequestId · integer<int64> · required

Response

200

application/json

successful operation

action · enum<string>

Available options: PRE_ANALYSE, POST_ANALYSE, CONTINUOUS_PRE_ANALYSE, CONTINUOUS_POST_ANALYSE, COMPARE_ANALYSE, PARENT_ANALYSE, PRE_TRANSLATE, ASYNC_TRANSLATE, IMPORT_JOB, IMPORT_FILE, ALIGN, EXPORT_TMX_BY_QUERY, EXPORT_TMX, IMPORT_TMX, IMPORT_MXLF_INTO_TM, IMPORT_TBX, IMPORT_TBX_TB3, INSERT_INTO_TM, DELETE_TM, CLEAR_TM, QA, QA_V3, UPDATE_CONTINUOUS_JOB, UPDATE_SOURCE, UPDATE_TARGET, EXTRACT_CLEANED_TMS, GLOSSARY_PUT, GLOSSARY_DELETE, ASYNC_TRANSLATE_VERIFY, CREATE_PROJECT, EXPORT_COMPLETE_FILE, IMPORT_ANNOTATIONS, FILE_FLOW_CONVERTER_IMPORT, FILE_FLOW_MT_PRETRANSLATE, FILE_FLOW_QUALITY_ESTIMATION, AUTO_LQA, ADOPT_SEGMENT_DATA, ADOPT_SEGMENT_SET_DATA, QP_EVALUATION

asyncResponse · object

Show child attributes

createdBy · object

Show child attributes

dateCreated · string<date-time>

id · string

parent · any

project · object

Show child attributes