Using the Asta Vision API to lock and unlock programmes

To lock the latest version of a programme for editing using the Asta Vision API, you must supply an API access key that specifies a user to which the 'Check In/Out Programme' security rule has been assigned as a header.

To lock the latest version of a programme using the Asta Vision API, use the following 'lock' HTTP request:

POST /programmes/{programmeGuid}/data/lock

Where {programmeGuid} is replaced by the unique identifier of the programme you want to lock. The request must include an API access key that specifies a user to which the 'Check In/Out Programme' security rule has been assigned as a header.

The 'lock' HTTP request returns an HTTP response that includes a 'lock key'. The response is as follows:

{

"lockKey" : "{programme lock key string}"

}

Where {programme lock key string} is replaced by the lock key that was returned by the 'lock' request.

In order to read or write to a programme's data using the Asta Vision API while the programme is locked, you must supply the lock key in the header of any HTTP requests, as follows:

X-LockKey: {programme lock key string}

Where {programme lock key string} is replaced by the lock key that was returned by the 'lock' request.

To unlock the latest version of a programme that had previously been locked using the Asta Vision API, you must POST an HTTP request to the unlock URI:

POST /programmes/{<programmeGuid}/data/unlock

Where {programmeGuid} is replaced by the unique identifier of the programme you want to unlock.

The body of the 'unlock' HTTP request must include the lock key and must specify whether a new version of the programme that incorporates your changes should be created when the programme is unlocked, and can optionally include additional parameters, in the following format:

{

"lockKey" : "{programme lock key string}"

"saveChanges" : "{true or false, should a new version be created}"

"versionName" : "{optional new version name}"

"versionDescriptions" : "{optional new version description}"

"progressDate" : "{optional new version progress date}"

"classificationValue" : "{optional new version classification id}"

}

Where:

• {programme lock key string} is replaced by the lock key that was returned by the 'lock' HTTP request.
• {true or false, should a new version be created} is replaced by true if you want to create a new version of the programme that incorporates your changes when the programme is unlocked; or by false if you do not want to create a new version of the programme when unlocking it, thereby discarding any changes that may have been made. Replace this with false if you have read, rather than edited, the programme's data while it was unlocked.
• {optional new version name} is replaced by the name that should be applied to the new version that you want to create when the programme is unlocked. Omit this parameter if you are not creating a new version.
• {optional new version description} is replaced by the description that should be applied to the new version that you want to create when the programme is unlocked. Omit this parameter if you are not creating a new version.
• {optional new version progress date} is replaced by the progress date that should be applied to the new version that you want to create when the programme is unlocked. Omit this parameter if you are not creating a new version.
• {optional new version classification id} is replaced by the ID of the revision classification that should be applied to the new version that you want to create when the programme is unlocked. Omit this parameter if you are not creating a new version.