Computations: Create Operation
Creates a single computation operation.
path Parameters
| accountId required | string |
query Parameters
| v required | string A date in |
| api_key required | string All requests will be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials. |
Request Body schema: application/json
The computation operation to be created.
required | (object or object) or (object or object) or (object or object) or (object or object) |
| languageCode | string Language code to be used to localize messages. If no language code is specified, it will default to English. |
object An arbitrary object that can hold any additional metadata provided by the caller. |
Responses
Request samples
- Payload
{- "definition": {
- "targetFields": {
- "ids": [
- "c_blogPost"
], - "uids": [
- "location.custom.123456.blogpost.0"
]
}, - "blankFieldBehavior": "WRITE_DIRECTLY",
- "populatedFieldBehavior": "WRITE_DIRECTLY",
- "entityScope": {
- "locales": [
- "en"
], - "entityIds": {
- "ids": [
- "customEntity"
], - "uids": [
- 1234
]
}
}
}, - "languageCode": "en",
- "details": {
- "source": "API Test"
}
}Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": "accounts/553564/computations/01HEV7A955WFEXNWDKRDRC5VM3",
- "uid": "01HEV7A955WFEXNWDKRDRC5VM3",
- "accountId": 553564,
- "createTime": "2023-11-09T23:40:12.325Z",
- "startTime": "2023-11-09T23:40:12.325Z",
- "completeTime": "2023-11-09T23:40:12.325Z",
- "definition": {
- "targetFields": {
- "ids": [
- "c_blogPost"
], - "uids": [
- "location.custom.123456.blogpost.0"
]
}, - "blankFieldBehavior": "WRITE_DIRECTLY",
- "populatedFieldBehavior": "WRITE_DIRECTLY",
- "entityScope": {
- "locales": [
- "en"
], - "entityIds": {
- "ids": [
- "customEntity"
], - "uids": [
- 1234
]
}
}, - "triggerType": "MANUAL"
}, - "languageCode": "en",
- "resultMetadata": {
- "updatedEntityProfileCount": 0,
- "updatedFieldCount": 0,
- "upsertedSuggestionsCount": 0,
- "updatedErrorCount": 0,
- "suggestionsErrorCount": 0,
- "generationErrors": 0,
- "status": "PROCESSING",
- "updateTime": "2023-11-09T23:40:17.065208732Z"
}, - "requestMetadata": {
- "entityProfileRequestCount": 1,
- "entityFieldRequestCount": 1,
- "planningCompleted": true
}
}
}Computations: List Operations
Retrieve a list of computation operations.
path Parameters
| accountId required | string |
query Parameters
| v required | string A date in |
| api_key required | string All requests will be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials. |
| pageSize | string Max Page Size = 1000 and unspecified defaults to 100. |
| pageToken | string If a response to a previous request contained the |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "pagination": {
- "pageToken": "CDk="
}
}, - "response": {
- "operations": [
- {
- "name": "accounts/553564/computations/01HEV7A955WFEXNWDKRDRC5VM3",
- "uid": "01HEV7A955WFEXNWDKRDRC5VM3",
- "accountId": 553564,
- "createTime": "2023-11-09T23:40:12.325Z",
- "startTime": "2023-11-09T23:40:12.325Z",
- "completeTime": "2023-11-09T23:40:12.325Z",
- "definition": {
- "targetFields": {
- "ids": [
- "c_blogPost"
], - "uids": [
- "location.custom.123456.blogpost.0"
]
}, - "blankFieldBehavior": "WRITE_DIRECTLY",
- "populatedFieldBehavior": "WRITE_DIRECTLY",
- "entityScope": {
- "locales": [
- "en"
], - "entityIds": {
- "ids": [
- "customEntity"
], - "uids": [
- 1234
]
}
}, - "triggerType": "MANUAL"
}, - "languageCode": "en",
- "resultMetadata": {
- "updatedEntityProfileCount": 0,
- "updatedFieldCount": 0,
- "upsertedSuggestionsCount": 0,
- "updatedErrorCount": 0,
- "suggestionsErrorCount": 0,
- "generationErrors": 0,
- "status": "PROCESSING",
- "updateTime": "2023-11-09T23:40:17.065208732Z"
}, - "requestMetadata": {
- "entityProfileRequestCount": 1,
- "entityFieldRequestCount": 1,
- "planningCompleted": true
}
}
]
}
}Computations: Cancel Operation
Cancels a computation operation.
path Parameters
| accountId required | string |
| operationUid required | string The Yext-generated unique identifier for the computation operation. |
query Parameters
| v required | string A date in |
| api_key required | string All requests will be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials. |
Responses
Response samples
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "errors": [
- {
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
]
}, - "response": { }
}Computations: Get Operation
Retrieve a single computation operation.
path Parameters
| accountId required | string |
| operationUid required | string The Yext-generated unique identifier for the computation operation. |
query Parameters
| v required | string A date in |
| api_key required | string All requests will be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials. |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": "accounts/553564/computations/01HEV7A955WFEXNWDKRDRC5VM3",
- "uid": "01HEV7A955WFEXNWDKRDRC5VM3",
- "accountId": 553564,
- "createTime": "2023-11-09T23:40:12.325Z",
- "startTime": "2023-11-09T23:40:12.325Z",
- "completeTime": "2023-11-09T23:40:12.325Z",
- "definition": {
- "targetFields": {
- "ids": [
- "c_blogPost"
], - "uids": [
- "location.custom.123456.blogpost.0"
]
}, - "blankFieldBehavior": "WRITE_DIRECTLY",
- "populatedFieldBehavior": "WRITE_DIRECTLY",
- "entityScope": {
- "locales": [
- "en"
], - "entityIds": {
- "ids": [
- "customEntity"
], - "uids": [
- 1234
]
}
}, - "triggerType": "MANUAL"
}, - "languageCode": "en",
- "resultMetadata": {
- "updatedEntityProfileCount": 0,
- "updatedFieldCount": 0,
- "upsertedSuggestionsCount": 0,
- "updatedErrorCount": 0,
- "suggestionsErrorCount": 0,
- "generationErrors": 0,
- "status": "PROCESSING",
- "updateTime": "2023-11-09T23:40:17.065208732Z"
}, - "requestMetadata": {
- "entityProfileRequestCount": 1,
- "entityFieldRequestCount": 1,
- "planningCompleted": true
}
}
}