Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetKxChangeset

Returns information about a kdb changeset.

Request Syntax


GET /kx/environments/environmentId/databases/databaseName/changesets/changesetId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

changesetId

A unique identifier of the changeset for which you want to retrieve data.

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: ^[a-zA-Z0-9]+$

Required: Yes

databaseName

The name of the kdb database.

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

Required: Yes

environmentId

A unique identifier for the kdb environment.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "activeFromTimestamp": number,
   "changeRequests": [ 
      { 
         "changeType": "string",
         "dbPath": "string",
         "s3Path": "string"
      }
   ],
   "changesetId": "string",
   "createdTimestamp": number,
   "databaseName": "string",
   "environmentId": "string",
   "errorInfo": { 
      "errorMessage": "string",
      "errorType": "string"
   },
   "lastModifiedTimestamp": number,
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

activeFromTimestamp

Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Type: Timestamp

changeRequests

A list of change request objects that are run in order.

Type: Array of ChangeRequest objects

Array Members: Minimum number of 1 item. Maximum number of 32 items.

changesetId

A unique identifier for the changeset.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: ^[a-zA-Z0-9]+$

createdTimestamp

The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Type: Timestamp

databaseName

The name of the kdb database.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

environmentId

A unique identifier for the kdb environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: .*\S.*

errorInfo

Provides details in the event of a failed flow, including the error type and the related error message.

Type: ErrorInfo object

lastModifiedTimestamp

The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Type: Timestamp

status

Status of the changeset creation process.

Pending – Changeset creation is pending.
Processing – Changeset creation is running.
Failed – Changeset creation has failed.
Complete – Changeset creation has succeeded.

Type: String

Valid Values: PENDING | PROCESSING | FAILED | COMPLETED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400