Operations available in the Asta Vision API
The following operations are available in the Asta Vision API, grouped by the resources on which the operations can be carried out.
Refer to the Asta Vision API Portal for full details of each operation, including details of the various query parameters that are available for each operation and the possible responses.
Project resources
It is not possible to use the Asta Vision API to delete projects.
Return a collection of projects
| Operation |
GET /projects
|
| Notes |
Retrieves a single project with /{projectGuid} added to the end of the URI.
By default, deleted and archived projects are omitted from the collection. To include them, set the includeDeleted and/or includeArchived query parameters to True.
By default, data on a project's programmes is included in the collection. To exclude programme data, set the includeProgrammeData query parameter to False.
|
Create a new project
| Operation |
POST /projects
|
| Notes |
Use the parameters to specify details of the new project. |
Assign a collection of user email addresses to a project
| Operation |
POST /projects/{projectGuid}/assignedusers
|
Update a project's name, notes or user-defined fields
| Operation |
PATCH /projects/{projectGuid}
|
| Notes |
This operation requires a JSON body with one or more fields from name, notes or udfs - depending on the data you want to update. |
Unassign a collection of user email addresses from a project
| Operation |
DELETE /projects/{projectGuid}/assignedusers
|
Programme resources
It is not possible to use the Asta Vision API to create or delete programmes.
Return a single programme
| Operation |
GET /programmes/{programmeGuid}
|
Download the latest version of a programme
| Operation |
GET /programmes/{programmeGuid}/download
|
| Notes |
Use the versionNumber parameter to download a specific version of the programme if required.
By default, baselines are excluded from the download. To include a baseline, set the includeBaselines parameter to True and use the baselineVersionNumber parameter to specify the version of the baseline that you want to download.
More information on using the Asta Vision API to upload and download programmes
|
Upload a new revision of a programme
Generate advanced Business Intelligence data for a historical version of a programme and baseline
| Operation |
POST /programmes/{programmeGuid}/advancedbi
|
| Notes |
Use the programmeVersion and baselineVersion parameters to specify the version of the programme and baseline for which you want to generate advanced Business Intelligence data. |
Update a programme's user-defined fields
| Operation |
PATCH /programmes/{programmeGuid}
|
| Notes |
This operation requires a JSON body with a list of user-defined fields. |
Programme version resources
Return a collection of the versions of a programme
| Operation |
GET /programmes/{programmeGuid}/versions
|
Return a collection of the versions of a programme's baselines
| Operation |
GET /programmes/{programmeGuid}/baselineversions
|
Programme workflow resources
Return a collection of the workflow actions currently available for a programme
| Operation |
GET /programmes/{programmeGuid}/actions
|
| Notes |
By default, only actions that are available to the programme in its current status are included. To include all available actions, regardless of the programme's current status, set the includeAllActions query parameter to True. |
Execute a workflow action on a programme
| Operation |
POST /programmes/{programmeGuid}/actions/{actionId}
|
| Notes |
Use the parameters to specify details of the workflow action to execute. |
Programme locking and unlocking
Lock the latest version of a programme
| Operation |
POST /programmes/{programmeGuid}/data/lock
|
| Notes |
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.
This operation returns a lock key, which can be used to access the programme's data while it is locked; the lock key must also be supplied to unlock the programme.
More information on using the Asta Vision API to lock and unlock programmes
|
Unlock the latest version of a programme
| Operation |
POST /programmes/{programmeGuid}/data/unlock
|
| Notes |
Supply the lock key that was returned by the 'lock' request in the lockKey parameter.
To create a new version of the programme when the programme is unlocked, set the saveChanges parameter to True; use the other optional parameters to specify details that should be applied to the new version of the programme.
More information on using the Asta Vision API to lock and unlock programmes
|
Chart resources
Although a chart is a type of task in Asta Powerproject, this interface includes only the fields for the hierarchy of charts and summary groups; the same chart ID can be used with the 'Task resources' URI to read and write other, non chart-related data.
Return a flattened collection of a programme's charts and summary groups
| Operation |
GET /programmes/{programmeGuid}/data/charts
|
| Notes |
Retrieves a single chart or summary group with /{chartId} added to the end of the URI. |
Return a flattened collection of a programme's charts and summary groups from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/charts
|
| Notes |
Retrieves a single chart or summary group with /{chartId} added to the end of the URI. |
Return a flattened collection of a programme's charts and summary groups from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/charts
|
| Notes |
Retrieves a single chart or summary group with /{chartId} added to the end of the URI. |
Create a new bar and chart within the specified parent chart
| Operation |
POST /programmes/{programmeGuid}/data/charts
|
| Notes |
Use the parentChartId parameter to specify the chart in which the new chart will be created; use the optional previousChartId parameter to specify that the new chart should be inserted immediately below a given chart - or at the very top of the programme, if you enter 0 in this parameter.
If you omit the previousChartId parameter, the new chart is inserted at the very bottom of the programme.
|
Update a chart or summary group's details
| Operation |
PATCH /programmes/{programmeGuid}/data/charts/{chartId}
|
| Notes |
Changing the parentChartId and previousChartId parameters changes the chart's position in the programme hierarchy. If you do this and the chart is the only task on its bar, the chart's bar is moved along with it; if any other tasks exist on the chart's bar, the chart is moved onto a new bar which is created specially for it. |
Delete a chart or summary group, together with its contents
| Operation |
DELETE /programmes/{programmeGuid}/data/charts/{chartId}
|
| Notes |
If the chart is the only task on its bar, the chart's bar is also deleted. |
Task resources
Return a collection of a programme's tasks, of all types
| Operation |
GET /programmes/{programmeGuid}/data/tasks
|
| Notes |
Retrieves a single task with /{taskId} added to the end of the URI.
When using this operation, if you do not request details of a single task, you must apply at least one method of task filtering, as if you did not, the collection returned would probably be unfeasibly large.
|
Return a collection of a programme's tasks from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks
|
| Notes |
Retrieves a single task with /{taskId} added to the end of the URI.
When using this operation, if you do not request details of a single task, you must apply at least one method of task filtering, as if you did not, the collection returned would probably be unfeasibly large.
|
Return a collection of a programme's tasks from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks
|
| Notes |
Retrieves a single task with /{taskId} added to the end of the URI.
When using this operation, if you do not request details of a single task, you must apply at least one method of task filtering, as if you did not, the collection returned would probably be unfeasibly large.
|
Return a collection of the tasks from within a specific chart or summary group
| Operation |
GET /programmes/{programmeGuid}/data/charts/{chartId}/tasks
|
| Notes |
Retrieves a single task with /{taskId} added to the end of the URI. |
Return a collection of the tasks from within a specific chart or summary group from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/charts/{chartId}/tasks
|
| Notes |
Retrieves a single task with /{taskId} added to the end of the URI. |
Return a collection of the tasks from within a specific chart or summary group from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/charts/{chartId}/tasks
|
| Notes |
Retrieves a single task with /{taskId} added to the end of the URI. |
Create a new task
| Operation |
POST /programmes/{programmeGuid}/data/tasks
|
| Notes |
Use the optional parentChartId parameter to specify the chart in which the new task will be created; use the optional parentBarId parameter to specify the bar on which the new task will be created.
If you specify a parent chart but no parent bar, the task will be created on a new bar at the bottom of the specified chart. If you specify a parent bar, the task will be created on that bar; if you specify both a parent chart and a parent bar, the bar takes priority.
|
Update a task's details
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}
|
| Notes |
Changing the parentChartId and chartOrder parameters changes the task's position in the hierarchy. If you do this and the task is the only task on its bar, the task's bar is moved along with it; if any other tasks exist on the bar, the task is moved onto a new bar which is created specially for it.
You cannot change both the parentChartId and chartOrder parameters in the same 'PATCH' HTTP request, unless the bar exists in the given chart.
Any attempts to carry out an invalid edit, for example, attempting to change a summary task into a hammock, will fail.
|
Delete a task, any allocations on the task, and all links that start or finish at the task
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}
|
| Notes |
If the task is the only one on its bar, the task's bar is also deleted. |
Task resources - bar data
Bars are primarily used to group tasks together on a single line in Asta Powerproject. However, some data is stored against bars that you may find useful, for example codes and user-defined fields.
Return a small set of bar data, including codes and user-defined fields that are assigned to the bar
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/bar
|
Return a small set of bar data, including codes and user-defined fields that are assigned to the bar, from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/bar
|
Return a small set of bar data, including codes and user-defined fields that are assigned to the bar, from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/bar
|
Return a collection of the code library entries that are assigned to a bar
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/bar/codes
|
Return a collection of the code library entries that are assigned to a bar from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/bar/codes
|
Return a collection of the code library entries that are assigned to a bar from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/bar/codes
|
Assign a code library entry to a bar
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/bar/codes
|
| Notes |
Use the parameters to specify details of the new code library assignment. |
Update a bar's details
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/bar
|
| Notes |
Use the name parameter to specify a new name for the bar.
Use the udfs parameter to edit the bar's user-defined fields.
|
Delete a code library assignment from a bar
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/bar/codes/{entryId}
|
Task resources - code data
Return a collection of the code library entries that are assigned to a task
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/codes
|
Return a collection of the code library entries that are assigned to a task from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/codes
|
Return a collection of the code library entries that are assigned to a task from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/codes
|
Assign a code library entry to a task
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/codes
|
| Notes |
Use the parameters to specify details of the new code library assignment. |
Delete a code library assignment from a task
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/codes/{entryId}
|
Task resources - completed section data
Return information on a task's completed sections
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/completedsections
|
Return information on a task's completed sections from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/completedsections
|
Return information on a task's completed sections from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/completedsections
|
Task resources - constraint data
Return a collection of the constraints that are applied to a task
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/constraints
|
Return a collection of the constraints that are applied to a task from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/constraints
|
Return a collection of the constraints that are applied to a task from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/constraints
|
Update a task constraint's details
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/constraints
|
| Notes |
Use the parameters to specify revised details for the constraint. |
Task resources - dated note data
Return a collection of a task's dated notes
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/datednotes
|
Return a collection of a task's dated notes from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/datednotes
|
Return a collection of a task's dated notes from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/datednotes
|
Create a new dated note against a task
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/datednotes
|
| Notes |
Use the parameters to specify details of the new dated note. |
Update a dated note's details
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/datednotes/{noteDate}
|
| Notes |
Use the parameters to specify revised details for the dated note. |
Delete a dated note from a task
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/datednotes/{noteDate}
|
Task resources - float data
Return information on a task's float
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/float
|
Return information on a task's float from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/float
|
Return information on a task's float from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/float
|
Task resources - link data
Return a collection of the links that finish at a task
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/linksin
|
Return a collection of the links that finish at a task from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/linksin
|
Return a collection of the links that finish at a task from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/linksin
|
Return a collection of the links that start at a task
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/linksout
|
Return a collection of the links that start at a task from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/linksout
|
Return a collection of the links that start at a task from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/linksout
|
Create a new link that finishes at a task
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/linksin
|
| Notes |
Use the parameters to specify details of the new link. |
Create a new link that starts at a task
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/linksout
|
| Notes |
Use the parameters to specify details of the new link. |
Update the details of a link that finishes at a task
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/linksin/{linkId}
|
| Notes |
Use the parameters to specify revised details for the link. |
Update the details of a link that starts at a task
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/linksout/{linkId}
|
| Notes |
Use the parameters to specify revised details for the link. |
Delete a link that finishes at a task
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/linksin/{linkId}
|
Delete a link that starts at a task
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/linksout/{linkId}
|
Task resources - progress data
Return information on a task's progress
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/progress
|
Return information on a task's progress from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/progress
|
Return information on a task's progress from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/progress
|
Apply progress to a task
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/progress
|
| Notes |
Use the parameters to specify details of the progress. |
Task resources - task activity data
Return a collection of a task's task activities
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/taskactivities
|
Return a collection of a task's task activities from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/taskactivities
|
Return a collection of a task's task activities from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/taskactivities
|
Create a new task activity against a task
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/taskactivities
|
| Notes |
Use the parameters to specify details of the new task activity. |
Updates a task activity's details
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/taskactivities/{activityId}
|
| Notes |
Use the parameters to specify revised details for the task activity. |
Deletes a task activity from a task
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/taskactivities/{activityId}
|
Task resources - task work data
Return information on a task's task work
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/taskwork
|
Return information on a task's task work from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/taskwork
|
Return information on a task's task work from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/taskwork
|
Updates a task's task work details
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/taskwork
|
| Notes |
Use the parameters to specify revised details for the task work. |
Code library and code library entry resources
Return a collection of a programme's code libraries
| Operation |
GET /programmes/{programmeGuid}/data/codelibraries
|
| Notes |
Retrieves a single code library with /{libraryId} added to the end of the URI. |
Return a collection of a programme's code libraries from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/codelibraries
|
| Notes |
Retrieves a single code library with /{libraryId} added to the end of the URI. |
Return a collection of a programme's code libraries from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/codelibraries
|
| Notes |
Retrieves a single code library with /{libraryId} added to the end of the URI. |
Return a collection of a code library's code library entries
| Operation |
GET /programmes/{programmeGuid}/data/codelibraries/{libraryId}/entries
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Return a collection of a code library's code library entries from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/codelibraries/{libraryId}/entries
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Return a collection of a code library's code library entries from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/codelibraries/{libraryId}/entries
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Return a collection of the tasks to which a code library entry has been assigned
| Operation |
GET /programmes/{programmeGuid}/data/codelibraries/{libraryId}/entries/{entryId}/tasks
|
Return a collection of the tasks to which a code library entry has been assigned from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/codelibraries/{libraryId}/entries/{entryId}/tasks
|
Return a collection of the tasks to which a code library entry has been assigned from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/codelibraries/{libraryId}/entries/{entryId}/tasks
|
Create a new code library
| Operation |
POST /programmes/{programmeGuid}/data/codelibraries
|
| Notes |
Use the parameters to specify details of the new code library. |
Create a new code library entry within a code library
| Operation |
POST /programmes/{programmeGuid}/data/codelibraries/{libraryId}/entries
|
| Notes |
Use the parameters to specify details of the new code library entry. |
Update a code library's details
| Operation |
PATCH /programmes/{programmeGuid}/data/codelibraries/{libraryId}
|
| Notes |
Use the parameters to specify revised details for the code library. |
Update a code library entry's details
| Operation |
PATCH /programmes/{programmeGuid}/data/codelibraries/{libraryId}/entries/{entryId}
|
| Notes |
Use the parameters to specify revised details for the code library entry. |
Delete a code library, any subordinate code library entries, and any assignments of the code library and its entries
| Operation |
DELETE /programmes/{programmeGuid}/data/codelibraries/{libraryId}
|
| Notes |
It is not possible to delete the default code library. |
Delete a code library entry, any subordinate code library entries, and any assignments of the entries
| Operation |
DELETE /programmes/{programmeGuid}/data/codelibraries/{libraryId}/entries/{entryId}
|
Calendar resources
Return a collection of a programme's calendars
| Operation |
GET /programmes/{programmeGuid}/data/calendars
|
| Notes |
Retrieves a single calendar with /{calendarId} added to the end of the URI. |
Return a collection of a programme's calendars from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/calendars
|
| Notes |
Retrieves a single calendar with /{calendarId} added to the end of the URI. |
Return a collection of a programme's calendars from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/calendars
|
| Notes |
Retrieves a single calendar with /{calendarId} added to the end of the URI. |
Return a collection of a calendar's work pattern assignments
| Operation |
GET /programmes/{programmeGuid}/data/calendars/{calendarId}/workpatterns
|
| Notes |
Retrieves a single work pattern assignment with /{patternOrderNumber} added to the end of the URI. |
Return a collection of a calendar's work pattern assignments from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/calendars/{calendarId}/workpatterns
|
| Notes |
Retrieves a single work pattern assignment with /{patternOrderNumber} added to the end of the URI. |
Return a collection of a calendar's work pattern assignments from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/calendars/{calendarId}/workpatterns
|
| Notes |
Retrieves a single work pattern assignment with /{patternOrderNumber} added to the end of the URI. |
Return a collection of a calendar's exception assignments
| Operation |
GET /programmes/{programmeGuid}/data/calendars/{calendarId}/exceptions
|
| Notes |
Retrieves a single exception assignment with /{exceptionOrderNumber} added to the end of the URI. |
Return a collection of a calendar's exception assignments from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/calendars/{calendarId}/exceptions
|
| Notes |
Retrieves a single exception assignment with /{exceptionOrderNumber} added to the end of the URI. |
Return a collection of a calendar's exception assignments from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/calendars/{calendarId}/exceptions
|
| Notes |
Retrieves a single exception assignment with /{exceptionOrderNumber} added to the end of the URI. |
Create a new calendar
| Operation |
POST /programmes/{programmeGuid}/data/calendars
|
| Notes |
Use the parameters to specify details of the new calendar. |
Create a new work pattern assignment within a calendar
| Operation |
POST /programmes/{programmeGuid}/data/calendars/{calendarId}/workpatterns
|
| Notes |
Use the parameters to specify details of the new work pattern assignment.
New work pattern assignments that are created in this way are placed in the sorted order according to start date. This could result in other items being deleted or truncated if they overlap with the newly-created resource.
|
Create a new exception assignment within a calendar
| Operation |
POST /programmes/{programmeGuid}/data/calendars/{calendarId}/exceptions
|
| Notes |
Use the parameters to specify details of the new exception assignment.
New exception assignments that are created in this way are placed in the sorted order according to start date. This could result in other items being deleted or truncated if they overlap with the newly-created resource.
|
Update a calendar's details
| Operation |
PATCH /programmes/{programmeGuid}/data/calendars/{calendarId}
|
| Notes |
Use the parameters to specify revised details for the calendar. |
Update the details of a work pattern assignment within a calendar
| Operation |
PATCH /programmes/{programmeGuid}/data/calendars/{calendarId}/workpatterns/{patternOrderNumber}
|
| Notes |
Identify the work pattern assignment you want to update by referring to its numeric position in the collection.
Use the parameters to specify revised details for the work pattern assignment.
|
Update the details of an exception assignment within a calendar
| Operation |
PATCH /programmes/{programmeGuid}/data/calendars/{calendarId}/exceptions/{exceptionOrderNumber}
|
| Notes |
Identify the exception assignment you want to update by referring to its numeric position in the collection.
Use the parameters to specify revised details for the exception assignment.
|
Delete a calendar and any subordinate calendars
| Operation |
DELETE /programmes/{programmeGuid}/data/calendars/{calendarId}
|
| Notes |
The default calendar is assigned automatically to any objects that use a calendar that is deleted in this way.
It is not possible to delete the default calendar.
|
Delete a work pattern assignment from a calendar
| Operation |
DELETE /programmes/{programmeGuid}/data/calendars/{calendarId}/workpatterns/{patternOrderNumber}
|
| Notes |
Identify the work pattern assignment you want to delete by referring to its numeric position in the collection. |
Delete an exception assignment from a calendar
| Operation |
DELETE /programmes/{programmeGuid}/data/calendars/{calendarId}/exceptions/{exceptionOrderNumber}
|
| Notes |
Identify the exception assignment you want to delete by referring to its numeric position in the collection. |
Calendar exception resources
Return a collection of a programme's calendar exceptions
| Operation |
GET /programmes/{programmeGuid}/data/exceptions
|
| Notes |
Retrieves a single calendar exception with /{exceptionId} added to the end of the URI. |
Return a collection of a programme's calendar exceptions from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/exceptions
|
| Notes |
Retrieves a single calendar exception with /{exceptionId} added to the end of the URI. |
Return a collection of a programme's calendar exceptions from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/exceptions
|
| Notes |
Retrieves a single calendar exception with /{exceptionId} added to the end of the URI. |
Create a new calendar exception
| Operation |
POST /programmes/{programmeGuid}/data/exceptions
|
| Notes |
Use the parameters to specify details of the new calendar exception. |
Update a calendar exception's details
| Operation |
PATCH /programmes/{programmeGuid}/data/exceptions/{exceptionId}
|
| Notes |
Use the parameters to specify revised details for the calendar exception. |
Delete a calendar exception
| Operation |
DELETE /programmes/{programmeGuid}/data/exceptions/{exceptionId}
|
| Notes |
Deleting a calendar exception deletes all exceptions of that type of calendars, and replaces them with the default working or non-working exception that matches the deleted exception's type.
It is not possible to delete one of the default calendar exceptions.
|
Calendar work pattern resources
Return a collection of a programme's work patterns
| Operation |
GET /programmes/{programmeGuid}/data/workpatterns
|
| Notes |
Retrieves a single work pattern with /{workPatternId} added to the end of the URI. |
Return a collection of a programme's work patterns from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/workpatterns
|
| Notes |
Retrieves a single work pattern with /{workPatternId} added to the end of the URI. |
Return a collection of a programme's work patterns from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/workpatterns
|
| Notes |
Retrieves a single work pattern with /{workPatternId} added to the end of the URI. |
Return a collection of a work patterns's shifts
| Operation |
GET /programmes/{programmeGuid}/data/workpatterns/{workPatternId}/shifts
|
| Notes |
Retrieves a single shift with /{shiftOrderNumber} added to the end of the URI. |
Return a collection of a work patterns's shifts from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/workpatterns/{workPatternId}/shifts
|
| Notes |
Retrieves a single shift with /{shiftOrderNumber} added to the end of the URI. |
Return a collection of a work patterns's shifts from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/workpatterns/{workPatternId}/shifts
|
| Notes |
Retrieves a single shift with /{shiftOrderNumber} added to the end of the URI. |
Return a collection of a work patterns's time unit overrides
| Operation |
GET /programmes/{programmeGuid}/data/workpatterns/{workPatternId}/timeunitoverrides
|
| Notes |
Retrieves a single time unit override with /{timeUnitId} added to the end of the URI. |
Return a collection of a work patterns's time unit overrides from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/workpatterns/{workPatternId}/timeunitoverrides
|
| Notes |
Retrieves a single time unit override with /{timeUnitId} added to the end of the URI. |
Return a collection of a work patterns's time unit overrides from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/workpatterns/{workPatternId}/timeunitoverrides
|
| Notes |
Retrieves a single time unit override with /{timeUnitId} added to the end of the URI. |
Create a new work pattern
| Operation |
POST /programmes/{programmeGuid}/data/workpatterns
|
| Notes |
Use the parameters to specify details of the new work pattern. |
Create a new shift within a work pattern
| Operation |
POST /programmes/{programmeGuid}/data/workpatterns/{workPatternId}/shifts
|
| Notes |
Use the parameters to specify details of the new shift.
New shifts that are created in this way are placed according to the order they are given in the order parameter.
|
Create a new time unit override within a work pattern
| Operation |
POST /programmes/{programmeGuid}/data/workpatterns/{workPatternId}/timeunitoverrides
|
| Notes |
Use the parameters to specify details of the new time unit override. |
Update a work pattern's details
| Operation |
PATCH /programmes/{programmeGuid}/data/workpatterns/{workPatternId}
|
| Notes |
Use the parameters to specify revised details for the work pattern. |
Update the details of a shift within a work pattern
| Operation |
PATCH /programmes/{programmeGuid}/data/workpatterns/{workPatternId}/shifts/{shiftOrderNumber}
|
| Notes |
Identify the shift you want to update by referring to its order, as given in the order parameter.
Use the parameters to specify revised details for the shift.
|
Delete a work pattern
| Operation |
DELETE /programmes/{programmeGuid}/data/workpatterns/{workPatternId}
|
| Notes |
It is not possible to delete one of the default work patterns, or a work pattern that is assigned to a calendar. |
Delete a shift from within a work pattern
| Operation |
DELETE /programmes/{programmeGuid}/data/workpatterns/{workPatternId}/shifts/{shiftOrderNumber}
|
| Notes |
Identify the shift you want to delete by referring to its order, as given in the order parameter. |
Delete a time unit override from within a work pattern
| Operation |
DELETE /programmes/{programmeGuid}/data/workpatterns/{workPatternId}/timeunitoverrides/{timeUnitId}
|
Consumable allocation resources
Return a collection of a task's consumable resource allocations
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/consumableallocations
|
| Notes |
Retrieves a single consumable resource allocation with /{allocationId} added to the end of the URI. |
Return a collection of a task's consumable resource allocations from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/consumableallocations
|
| Notes |
Retrieves a single consumable resource allocation with /{allocationId} added to the end of the URI. |
Return a collection of a task's consumable resource allocations from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/consumableallocations
|
| Notes |
Retrieves a single consumable resource allocation with /{allocationId} added to the end of the URI. |
Create a new consumable resource allocation against a task
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/consumableallocations
|
| Notes |
Use the parameters to specify details of the new consumable resource allocation.
The 'POST' HTTP request does not include all available parameters for an allocation, as when new allocations are created, they use the consumable resource default parameters.
|
Update a consumable resource allocation's details
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/consumableallocations/{allocationId}
|
| Notes |
Use the parameters to specify revised details for the consumable resource allocation.
Consumable resource allocations have many inter-dependent fields; passing invalid combinations results in an error. Passing a value for a calculated field does not result in an error.
You cannot reassign existing allocations by editing the allocationOfId value; you cannot change the demand/scheduled state.
|
Delete a consumable resource allocation
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/consumableallocations/{allocationId}
|
Consumable allocation resources - code data
Return a collection of the code library entries assigned to a consumable resource allocation
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/consumableallocations/{allocationId}/codes
|
Return a collection of the code library entries assigned to a consumable resource allocation from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/consumableallocations/{allocationId}/codes
|
Return a collection of the code library entries assigned to a consumable resource allocation from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/consumableallocations/{allocationId}/codes
|
Assign a code library entry to a consumable resource allocation
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/consumableallocations/{allocationId}/codes
|
| Notes |
Use the parameters to specify details of the new code library assignment. |
Delete a code library assignment from a consumable resource allocation
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/consumableallocations/{allocationId}/codes/{entryId}
|
Consumable resource resources
Return a collection of a programme's consumable resources
| Operation |
GET /programmes/{programmeGuid}/data/consumableresources
|
| Notes |
Retrieves a single consumable resource with /{consumableResourceId} added to the end of the URI.
Data relating to default code library assignments is returned for each resource by default.
|
Return a collection of a programme's consumable resources from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/consumableresources
|
| Notes |
Retrieves a single consumable resource with /{consumableResourceId} added to the end of the URI.
Data relating to default code library assignments is returned for each resource by default.
|
Return a collection of a programme's consumable resources from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/consumableresources
|
| Notes |
Retrieves a single consumable resource with /{consumableResourceId} added to the end of the URI.
Data relating to default code library assignments is returned for each resource by default.
|
Create a new consumable resource
| Operation |
POST /programmes/{programmeGuid}/data/consumableresources
|
| Notes |
Use the parameters to specify details of the new consumable resource.
Consumable resources have many inter-dependent fields; passing invalid combinations results in an error. Passing a value for a calculated field does not result in an error.
|
Update a consumable resource's details
| Operation |
PATCH /programmes/{programmeGuid}/data/consumableresources/{consumableResourceId}
|
| Notes |
Use the parameters to specify revised details for the consumable resource.
Consumable resources have many inter-dependent fields; passing invalid combinations results in an error. Passing a value for a calculated field does not result in an error.
|
Delete a consumable resource and any subordinate resources
| Operation |
DELETE /programmes/{programmeGuid}/data/consumableresources/{consumableResourceId}
|
Consumable resource resources - code data
Return a collection of the code library entries assigned to a consumable resource
| Operation |
GET /programmes/{programmeGuid}/data/consumableresources/{consumableResourceId}/codes
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Return a collection of the code library entries assigned to a consumable resource from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/consumableresources/{consumableResourceId}/codes
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Return a collection of the code library entries assigned to a consumable resource from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}consumableresources/{consumableResourceId}/codes
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Assign a code library entry to a consumable resource
| Operation |
POST /programmes/{programmeGuid}/data/consumableresources/{consumableResourceId}/codes
|
| Notes |
Use the parameters to specify details of the new code library assignment. |
Delete a code library assignment from a consumable resource
| Operation |
DELETE /programmes/{programmeGuid}/data/consumable resources/{consumableResourceId}/codes/{entryId}
|
Cost allocation resources
Return a collection of a task's cost allocations
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/costallocations
|
| Notes |
Retrieves a single cost allocation with /{allocationId} added to the end of the URI. |
Return a collection of a task's cost allocations from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/costallocations
|
| Notes |
Retrieves a single cost allocation with /{allocationId} added to the end of the URI. |
Return a collection of a task's cost allocations from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/costallocations
|
| Notes |
Retrieves a single cost allocation with /{allocationId} added to the end of the URI. |
Create a new cost allocation against a task
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/costallocations
|
| Notes |
Use the parameters to specify details of the new cost allocation.
The 'POST' HTTP request does not include all available parameters for an allocation, as when new allocations are created, they use the cost centre default parameters.
|
Update a cost allocation's details
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/costallocations/{allocationId}
|
| Notes |
Use the parameters to specify revised details for the cost allocation.
Cost allocations have many inter-dependent fields; passing invalid combinations results in an error. Passing a value for a calculated field does not result in an error.
You cannot reassign existing allocations by editing the allocationOfId value.
|
Delete a cost allocation
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/costallocations/{allocationId}
|
Cost allocation resources - code data
Return a collection of the code library entries assigned to a cost allocation
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/costallocations/{allocationId}/codes
|
Return a collection of the code library entries assigned to a cost allocation from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/costallocations/{allocationId}/codes
|
Return a collection of the code library entries assigned to a cost allocation from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/costallocations/{allocationId}/codes
|
Assign a code library entry to a cost allocation
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/costallocations/{allocationId}/codes
|
| Notes |
Use the parameters to specify details of the new code library assignment. |
Delete a code library assignment from a cost allocation
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/costallocations/{allocationId}/codes/{entryId}
|
Cost and income rate resources
Return a collection of a programme's cost and income rates
| Operation |
GET /programmes/{programmeGuid}/data/costrates
|
| Notes |
Retrieves a single cost and income rate with /{costRateId} added to the end of the URI. |
Return a collection of a programme's cost and income rates from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/costrates
|
| Notes |
Retrieves a single cost and income rate with /{costRateId} added to the end of the URI. |
Return a collection of a programme's cost and income rates from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/costrates
|
| Notes |
Retrieves a single cost and income rate with /{costRateId} added to the end of the URI. |
Create a new cost and income rate
| Operation |
POST /programmes/{programmeGuid}/data/costrates
|
| Notes |
Use the parameters to specify details of the new cost and income rate. |
Update a cost and income rate's details
| Operation |
PATCH /programmes/{programmeGuid}/data/costrates/{costRateId}
|
| Notes |
Use the parameters to specify revised details for the cost and income rate. |
Delete a cost and income rate
| Operation |
DELETE /programmes/{programmeGuid}/data/costrates/{costRateId}
|
| Notes |
Deleting a cost and income rate deletes all its assignments. |
Cost centre resources
Return a collection of a programme's cost centres
| Operation |
GET /programmes/{programmeGuid}/data/costcentres
|
| Notes |
Retrieves a single cost centre with /{costCentreId} added to the end of the URI. |
Return a collection of a programme's cost centres from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/costcentres
|
| Notes |
Retrieves a single cost centre with /{costCentreId} added to the end of the URI. |
Return a collection of a programme's cost centres from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/costcentres
|
| Notes |
Retrieves a single cost centre with /{costCentreId} added to the end of the URI. |
Create a new cost centre
| Operation |
POST /programmes/{programmeGuid}/data/costcentres
|
| Notes |
Use the parameters to specify details of the new cost centre. |
Update a cost centre's details
| Operation |
PATCH /programmes/{programmeGuid}/data/costcentres/{costCentreId}
|
| Notes |
Use the parameters to specify revised details for the cost centre. |
Delete a cost centre
| Operation |
DELETE /programmes/{programmeGuid}/data/costcentres/{costCentreId}
|
| Notes |
It is not possible to delete the default cost centre. |
Cost centre resources - code data
Return a collection of the code library entries assigned to a cost centre
| Operation |
GET /programmes/{programmeGuid}/data/costcentres/{costCentreId}/codes
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Return a collection of the code library entries assigned to a cost centre from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/costcentres/{costCentreId}/codes
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Return a collection of the code library entries assigned to a cost centre from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/costcentres/{costCentreId}/codes
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Assign a code library entry to a cost centre
| Operation |
POST /programmes/{programmeGuid}/data/costcentres/{costCentreId}/codes
|
| Notes |
Use the parameters to specify details of the new code library assignment. |
Delete a code library assignment from a cost centre
| Operation |
DELETE /programmes/{programmeGuid}/data/costcentres/{costCentreId}/codes/{entryId}
|
Link category resources
Return a collection of a programme's link categories
| Operation |
GET /programmes/{programmeGuid}/data/linkcategories
|
| Notes |
Retrieves a single link category with /{linkCategoryId} added to the end of the URI. |
Return a collection of a programme's link categories from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/linkcategories
|
| Notes |
Retrieves a single link category with /{linkCategoryId} added to the end of the URI. |
Return a collection of a programme's link categories from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/linkcategories
|
| Notes |
Retrieves a single link category with /{linkCategoryId} added to the end of the URI. |
Create a new link category
| Operation |
POST /programmes/{programmeGuid}/data/linkcategories
|
| Notes |
Use the name parameter to specify the name of the new link category. |
Update the name of a link category
| Operation |
PATCH /programmes/{programmeGuid}/data/linkcategories/{linkCategoryId}
|
| Notes |
Use the name parameter to specify a new name for the link category. |
Delete a link category
| Operation |
DELETE /programmes/{programmeGuid}/data/linkcategories/{linkCategoryId}
|
Material resources
Return a collection of a programme's materials
| Operation |
GET /programmes/{programmeGuid}/data/materials
|
| Notes |
Retrieves a single material with /{materialId} added to the end of the URI. |
Return a collection of a programme's materials from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/materials
|
| Notes |
Retrieves a single material with /{materialId} added to the end of the URI. |
Return a collection of a programme's materials from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/materials
|
| Notes |
Retrieves a single material with /{materialId} added to the end of the URI. |
Create a new material
| Operation |
POST /programmes/{programmeGuid}/data/materials
|
| Notes |
Use the name parameter to specify the name of the new material. |
Update the name of a material
| Operation |
PATCH /programmes/{programmeGuid}/data/materials/{materialId}
|
| Notes |
Use the name parameter to specify a new name for the material. |
Delete a material
| Operation |
DELETE /programmes/{programmeGuid}/data/materials/{materialId}
|
Permanent allocation resources
Return a collection of a programme's permanent allocations
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/permanentallocations
|
| Notes |
Retrieves a single permanent resource allocation with /{allocationId} added to the end of the URI. |
Return a collection of a programme's permanent allocations from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/permanentallocations
|
| Notes |
Retrieves a single permanent resource allocation with /{allocationId} added to the end of the URI. |
Return a collection of a programme's permanent allocations from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/permanentallocations
|
| Notes |
Retrieves a single permanent resource allocation with /{allocationId} added to the end of the URI. |
Create a new permanent resource allocation against a task
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/permanentallocations
|
| Notes |
Use the parameters to specify details of the new permanent resource allocation.
The 'POST' HTTP request does not include all available parameters for an allocation, as when new allocations are created, they use the permanent resource default parameters.
|
Update a permanent resource allocation's details
| Operation |
PATCH /programmes/{programmeGuid}/data/tasks/{taskId}/permanentallocations/{allocationId}
|
| Notes |
Use the parameters to specify revised details for the permanent resource allocation.
Permanent resource allocations have many inter-dependent fields; passing invalid combinations results in an error. Passing a value for a calculated field does not result in an error.
You cannot reassign existing allocations by editing the allocationOfId value; you cannot change the demand/scheduled state.
|
Deletes a permanent allocation
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/permanentallocations/{allocationId}
|
Permanent allocation resources - code data
Return a collection of the code library entries assigned to a permanent resource allocation
| Operation |
GET /programmes/{programmeGuid}/data/tasks/{taskId}/permanentallocations/{allocationId}/codes
|
Return a collection of the code library entries assigned to a permanent resource allocation from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/tasks/{taskId}/permanentallocations/{allocationId}/codes
|
Return a collection of the code library entries assigned to a permanent resource allocation from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/tasks/{taskId}/permanentallocations/{allocationId}/codes
|
Assign a code library entry to a permanent resource allocation
| Operation |
POST /programmes/{programmeGuid}/data/tasks/{taskId}/permanentallocations/{allocationId}/codes
|
| Notes |
Use the parameters to specify details of the new code library assignment. |
Delete a code library assignment from a permanent resource allocation
| Operation |
DELETE /programmes/{programmeGuid}/data/tasks/{taskId}/permanentallocations/{allocationId}/codes/{entryId}
|
Permanent resource resources
Return a collection of a programme's permanent resources
| Operation |
GET /programmes/{programmeGuid}/data/permanentresources
|
| Notes |
Retrieves a single permanent resource with /{permanentResourceId} added to the end of the URI.
For simple resource hierarchies (ie ones without multi-skilled resources), data relating to the parent skill is returned as a nested array, in addition to data about each resource.
Data relating to default code library assignments is returned for each resource by default.
Data relating to standard work is returned if specifically requested.
|
Return a collection of a programme's permanent resources from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/permanentresources
|
| Notes |
Retrieves a single permanent resource with /{permanentResourceId} added to the end of the URI.
For simple resource hierarchies (ie ones without multi-skilled resources), data relating to the parent skill is returned as a nested array, in addition to data about each resource.
Data relating to default code library assignments is returned for each resource by default.
Data relating to standard work is returned if specifically requested.
|
Return a collection of a programme's permanent resources from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/permanentresources
|
| Notes |
Retrieves a single permanent resource with /{permanentResourceId} added to the end of the URI.
For simple resource hierarchies (ie ones without multi-skilled resources), data relating to the parent skill is returned as a nested array, in addition to data about each resource.
Data relating to default code library assignments is returned for each resource by default.
Data relating to standard work is returned if specifically requested.
|
Return a collection of the standard work assigned to a permanent resource
| Operation |
GET /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}/standardwork
|
| Notes |
Retrieves a single standard work assignment with /{standardWorkId} added to the end of the URI. |
Return a collection of the standard work assigned to a permanent resource from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/permanentresources/{permanentResourceId}/standardwork
|
| Notes |
Retrieves a single standard work assignment with /{standardWorkId} added to the end of the URI. |
Return a collection of the standard work assigned to a permanent resource from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/permanentresources/{permanentResourceId}/standardwork
|
| Notes |
Retrieves a single standard work assignment with /{standardWorkId} added to the end of the URI. |
Return a collection of a permanent resource's skills
| Operation |
GET /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}/skills
|
| Notes |
Retrieves a single skill with /{standardWorkId} added to the end of the URI. |
Return a collection of a permanent resource's skills from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/permanentresources/{permanentResourceId}/skills
|
| Notes |
Retrieves a single skill with /{standardWorkId} added to the end of the URI. |
Return a collection of a permanent resource's skills from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/permanentresources/{permanentResourceId}/skills
|
| Notes |
Retrieves a single skill with /{standardWorkId} added to the end of the URI. |
Create a new permanent resource
| Operation |
POST /programmes/{programmeGuid}/data/permanentresources
|
| Notes |
Use the parameters to specify details of the new permanent resource.
Permanent resources have many inter-dependent fields; passing invalid combinations results in an error. Passing a value for a calculated field does not result in an error.
|
Create a new skill for a permanent resource
| Operation |
POST /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}/skills
|
| Notes |
Use the parameters to specify details of the new skill.
|
Create a new standard work assignment for a permanent resource
| Operation |
POST /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}/standardwork
|
| Notes |
Use the parameters to specify details of the new standard work assignment.
|
Update a permanent resource's details
| Operation |
PATCH /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}
|
| Notes |
Use the parameters to specify revised details for the permanent resource.
Permanent resources have many inter-dependent fields; passing invalid combinations results in an error. Passing a value for a calculated field does not result in an error.
|
Update a permanent resource's skill-related details
| Operation |
PATCH /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}/skills/{skillId}
|
| Notes |
Use the parameters to specify revised skill-related details for the permanent resource.
Permanent resources have many inter-dependent fields; passing invalid combinations results in an error. Passing a value for a calculated field does not result in an error.
|
Update a permanent resource's standard work assignment
| Operation |
PATCH /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}/standardwork/{order}
|
| Notes |
Identify the standard work assignment you want to update by referring to its order, as given in the order parameter
Use the parameters to specify revised details for the standard work assignment.
|
Delete a permanent resource, and any subordinate resources and skills
| Operation |
DELETE /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}
|
Delete a permanent resource's skill
| Operation |
DELETE /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}/skills/{skillId}
|
Delete a permanent resource's standard work assignment
| Operation |
DELETE /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}/standardwork/{order}
|
Permanent resource resources - code data
Return a collection of the code library entries assigned to a permanent resource
| Operation |
GET /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}/skills/{skillId}/codes
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Return a collection of the code library entries assigned to a permanent resource from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/permanentresources/{permanentResourceId}/skills/{skillId}/codes
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Return a collection of the code library entries assigned to a permanent resource from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/permanentresources/{permanentResourceId}/skills/{skillId}/codes
|
| Notes |
Retrieves a single code library entry with /{entryId} added to the end of the URI. |
Assign a code library entry to a permanent resource
| Operation |
POST /programmes/{programmeGuid}/data/permanentresources/{permanentResourceId}/skills/{skillId}/codes
|
| Notes |
Use the parameters to specify details of the new code library assignment. |
Delete a code library assignment from a permanent resource
| Operation |
DELETE /programmes/{programmeGuid}/data/permanent resources/{permanentResourceId}/skills/{skillId}/codes/{entryId}
|
Progress period resources
Return a collection of a programme's progress periods
| Operation |
GET /programmes/{programmeGuid}/data/progressperiods
|
| Notes |
Retrieves a single progress period with /{periodId} added to the end of the URI. |
Return a collection of a programme's progress periods from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/progressperiods
|
| Notes |
Retrieves a single progress period with /{periodId} added to the end of the URI. |
Return a collection of a programme's progress periods from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/progressperiods
|
| Notes |
Retrieves a single progress period with /{periodId} added to the end of the URI. |
Create a new progress period
| Operation |
POST /programmes/{programmeGuid}/data/progressperiods
|
| Notes |
Use the parameters to specify details of the new progress period. |
Update a progress period's details
| Operation |
PATCH /programmes/{programmeGuid}/data/progressperiods/{periodId}
|
| Notes |
Use the parameters to specify revised details for the progress period.
It is not possible to set the parentProgressPeriodId parameter to one of the progress period's subordinate progress periods; it is not possible to set a locked progress period to be the default progress period.
|
Delete a progress period and any subordinate progress periods
| Operation |
DELETE /programmes/{programmeGuid}/data/progressperiods/{periodId}
|
| Notes |
If you delete a progress period, any progress that has been recorded using that progress period is switched to using the default progress period.
It is not possible to delete the default progress period.
|
Resource curve resources
Return a collection of a programme's resource curves
| Operation |
GET /programmes/{programmeGuid}/data/resourcecurves
|
| Notes |
Retrieves a single resource curve with /{resourceCurveId} added to the end of the URI. |
Return a collection of a programme's resource curves from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/resourcecurves
|
| Notes |
Retrieves a single resource curve with /{resourceCurveId} added to the end of the URI. |
Return a collection of a programme's resource curves from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/resourcecurves
|
| Notes |
Retrieves a single resource curve with /{resourceCurveId} added to the end of the URI. |
Create a new resource curve
| Operation |
POST /programmes/{programmeGuid}/data/resourcecurves
|
| Notes |
Use the parameters to specify details of the new resource curve. |
Update a resource curve's details
| Operation |
PATCH /programmes/{programmeGuid}/data/resourcecurves/{resourceCurveId}
|
| Notes |
Use the parameters to specify revised details for the resource curve. |
Delete a resource curve
| Operation |
DELETE /programmes/{programmeGuid}/data/resourcecurves/{resourceCurveId}
|
Standard work resources
Return a collection of a programme's standard work types
| Operation |
GET /programmes/{programmeGuid}/data/standardwork
|
| Notes |
Retrieves a single standard work type with /{standardWorkId} added to the end of the URI. |
Return a collection of a programme's standard work types from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/standardwork
|
| Notes |
Retrieves a single standard work type with /{standardWorkId} added to the end of the URI. |
Return a collection of a programme's standard work types from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/standardwork
|
| Notes |
Retrieves a single standard work type with /{standardWorkId} added to the end of the URI. |
Create a new standard work type
| Operation |
POST /programmes/{programmeGuid}/data/standardwork
|
| Notes |
Use the parameters to specify details of the new standard work type. |
Update a standard work type's details
| Operation |
PATCH /programmes/{programmeGuid}/data/standardwork/{standardWorkId}
|
| Notes |
Use the parameters to specify revised details for the standard work type. |
Delete a standard work type
| Operation |
DELETE /programmes/{programmeGuid}/data/standardwork/{standardWorkId}
|
| Notes |
It is not possible to delete the default standard work type. |
Time unit resources
Return a collection of a programme's time units
| Operation |
GET /programmes/{programmeGuid}/data/timeunits
|
| Notes |
Retrieves a single time unit with /{timeUnitId} added to the end of the URI. |
Return a collection of a programme's time units from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/timeunits
|
| Notes |
Retrieves a single time unit with /{timeUnitId} added to the end of the URI. |
Return a collection of a programme's time units from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/timeunits
|
| Notes |
Retrieves a single time unit with /{timeUnitId} added to the end of the URI. |
Create a new time unit
| Operation |
POST /programmes/{programmeGuid}/data/timeunits
|
| Notes |
Use the parameters to specify details of the new time unit. |
Update a time unit's details
| Operation |
PATCH /programmes/{programmeGuid}/data/timeunits/{timeUnitId}
|
| Notes |
Use the parameters to specify revised details for the time unit. |
Delete a time unit
| Operation |
DELETE /programmes/{programmeGuid}/data/timeunits/{timeUnitId}
|
User-defined field metadata resources
Return a collection of a programme's user-defined field metadata, and the object types on which they are available
| Operation |
GET /programmes/{programmeGuid}/data/udfs
|
| Notes |
Retrieves a single user-defined field with /{udfId} added to the end of the URI. |
Return a collection of a programme's user-defined field metadata, and the object types on which they are available, from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/udfs
|
| Notes |
Retrieves a single user-defined field with /{udfId} added to the end of the URI. |
Return a collection of a programme's user-defined field metadata, and the object types on which they are available, from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/udfs
|
| Notes |
Retrieves a single user-defined field with /{udfId} added to the end of the URI. |
Work unit resources
Return a collection of a programme's work units
| Operation |
GET /programmes/{programmeGuid}/data/workunits
|
| Notes |
Retrieves a single work unit with /{workUnitId} added to the end of the URI. |
Return a collection of a programme's work units from a specific version of a programme
| Operation |
GET /programmes/{programmeGuid}/data/{version}/workunits
|
| Notes |
Retrieves a single work unit with /{workUnitId} added to the end of the URI. |
Return a collection of a programme's work units from a specific version of a baseline
| Operation |
GET /programmes/{programmeGuid}/baselinedata/{baselineVersion}/workunits
|
| Notes |
Retrieves a single work unit with /{workUnitId} added to the end of the URI. |
Create a new work unit
| Operation |
POST /programmes/{programmeGuid}/data/workunits
|
| Notes |
Use the parameters to specify details of the new work unit. |
Update a work unit's details
| Operation |
PATCH /programmes/{programmeGuid}/data/workunits/{workUnitId}
|
| Notes |
Use the parameters to specify revised details for the work unit. |
Delete a work unit
| Operation |
DELETE /programmes/{programmeGuid}/data/workunits/{workUnitId}
|
Webhook resources
Return a collection of webhooks
| Operation |
GET /webhooks
|
| Notes |
Retrieves a single webhook with /{subscriptionId} added to the end of the URI.
You can also view a list of webhooks within Asta Vision.
More information on webhooks
|
Create - or 'subscribe to' - a webhook
| Operation |
POST /webhooks/subscribe
|
| Notes |
Use the parameters to specify details of the new webhook.
You can also create webhooks within Asta Vision.
More information on webhooks
|
Update a webhook's details
| Operation |
PATCH /webhooks/{subscriptionId}
|
| Notes |
Use the parameters to specify revised details for the webhook.
You can also edit the details of webhooks within Asta Vision.
More information on webhooks
|
Delete - or 'unsubscribe from' - a webhook
Related Topics:
Introduction to the Asta Vision API
Understanding API terminology
Creating access keys for the Asta Vision API
Using the API Portal to learn about and construct HTTP requests
Accessing historical data using the Asta Vision API
Filtering the tasks that are returned in a collection by the Asta Vision API
Creating webhooks for the Asta Vision API
Using the Asta Vision API to lock and unlock programmes
Using the Asta Vision API to upload and download programmes