Skip to main content

API Changelog

v1 (2024-02-23)​

A number of features that were in early access preview are now available:

v1 (2024-01-08)​

  • Early access preview (API reference only) of the ability to import items from a CSV file. This will be available via a PUT request to the "Async import" endpoint.

v1 (2023-09-27)​

v1 (2023-09-18)​

  • Early access preview (API reference only) of the ability to populate a links dataset using information from a single dataset (if it contains the from_id, to_id and allocation properties). This will be available via a PUT request to the "Populate a links dataset" endpoint.

v1 (2023-09-11)​

  • Early access preview (API reference only) of the ability to link a dataset when refreshing on-demand calculation results in a dataset. This will allow calculations that rely on linked data to run as intended. This will be available via an update to the "Evaluate on-demand calculations" endpoint.

v1 (2023-09-01)​

v1 (23-08-01)​

Notice of deprecation

As we are still in Beta access there are some changes that under "stable API" circumstances would be breaking:

v1 (2023-07-26)​

v1 (2023-07-18)​

We now have a section on Postman collections, along with our first Postman collection and guide on Async Import.

v1 (2023-07-11)​

v1 (2023-06-23)​

v1 (2023-06-22)​

A number of features that were in early access preview are now available:

  • The new endpoint for synchronous importing changes to a linking dataset (type "LINKS"). This is now possible via the dedicated links "Sync import" endpoint.

Notice of deprecation

As we are still in Beta there are some changes that under "stable API" circumstances would be breaking:

  • The existing synchronous and asynchronous endpoints for importing items to a dataset no longer support linking datasets. You will only be able to import "LINKS" datasets via the new dedicated endpoint.

v1 (2023-06-12)​

Support for customer callbacks per request is now available on all our asynchronous endpoints. For more information please refer to individual endpoints' documentation. Instead of polling a jobTicket to completion, you can receive a callback to a location of your choice that your job is ready.

v1 (2023-05-26)​

  • Early access preview (API reference only) procedure for importing changes to a linking dataset (type "LINKS") modified. This will now be made possible via dedicated links "Sync import" and "Async import" endpoints.

v1 (2023-05-24)​

A number of features that were in early access preview are now available:

v1 (2023-05-23)​

  • Early access preview (API reference only) of the ability to import changes to a linking dataset (dataset of type "LINKS"). This will be made possible via extending the capabilities of the existing "Sync import" and "Async import" endpoints.

v1 (2023-05-09)​

We have added a "Feedback" section to our documentation with instructions for how to submit feedback on the API.

v1 (2023-04-06)​

A number of features that were in early access preview are now available:

  • The synchronous endpoint providing the ability to Clear draft actions for removing any edits, changes, or additions that you have made to the dataset in draft and restoring it to its original state. This would effectively erase all of your work on the draft.

  • The synchronous endpoint providing the ability to list drafts with specified filter and/or projection

v1 (2023-04-03)​

A number of features that were in early access preview are now available:

  • The synchronous endpoint providing the ability to create secure temporary files that are encrypted at rest by Orgvue. The temporary files can be accessed via a resource that itself has a limited lifespan.
  • The asynchronous endpoint providing the ability to create, update or delete items by providing a secure resource that contains the content to ingest. The secure location must provide https GET capability, and ideally is generated using our temporary file capability.
  • Updated content allowing key information to be returned for all drafts attached to a dataset via the "Dataset metadata" endpoint.
  • The synchronous endpoint providing the ability to retrieve information about a draft resource with the "Draft metadata" endpoint. This will provide a link to discover further draft actions.

v1 (2023-03-17)​

v1 (2023-03-03)​

v1 (2023-02-16)​

v1 (2023-02-09)​

  • Early access preview (API reference only) of the ability to generate temporary files that are encrypted at rest by Orgvue. The temporary files can be accessed via a resource that itself has a limited lifespan.
  • Early access preview (API reference only) of an asynchronous endpoint providing the ability to create, update or delete items by providing a secure resource that contains the content to ingest. The secure location must provide https GET capability, and ideally is generated using our temporary file capability.
  • Early access preview (API reference only): key information to be returned for all drafts attached to a dataset via the "Dataset metadata" endpoint.
  • Early access preview (API reference only) of the ability to retrieve information about a draft resource with the "Draft Metadata" endpoint. This will provide a link to discover further draft actions.

Notice of future deprecation

As we are still in Beta access there are some changes that under "stable API" circumstances would be breaking:

  • We aim to rename the attribute used for providing your own infrastructure location to store the results of your dataset export. For the time being exportLocation will be accepted, and the resultLocation attribute will offer the same capability. We ultimately aim to remove exportLocation and only support resultLocation.

v1 (2023-02-01)​

The datasets and dataset retrieve endpoint responses have been updated for simpler navigation and a technical inaccuracy has been fixed:

  • The datasets retrieve endpoint now only returns a single export link for the default export format. For all export options you can follow the dataset:retrieve link to the single dataset retrieve endpoint.
  • Linking relationships now include dataset:retrieve under _links to allow navigation from your source dataset to either a target dataset or a linking dataset itself.
  • Any dataset that is not a linking dataset will always contain target dataset information in its linkingRelationships. This reflects the fact that the terms source and target are relative, not absolute. The dataset specified in the path is considered to be the source so any linked datasets are by definition the target. A future update will clarify the terminology in the documentation.
  • A linking dataset will now contain information for the two datasets it links (under linkingRelationships) with source and target both ways round. Again, this reflects the relative nature of source and target.

v1 (2023-01-25)​

A number of features that were in early access preview are now available:

  • An endpoint that allows items to be created, updated or deleted.
  • A filter by date capability for asynchronous export endpoint. You can provide your date filters in one of the supported date formats.
  • The injection of a Byte Order Mark for TSV and CSV exports. This will be possible by means of the includeBOM boolean query parameter, for our export endpoints.
  • Control over the line endings for TSV and CSV exports. This will be possible by means of the lineEndings query parameter, for our export endpoints.
  • The ability to set gzip compression for our asynchronous export endpoint. You can set the encoding query parameter that encodes the result of the export.

v1 (2023-01-19)​

v1 (2023-01-19)​

  • Early access preview (API reference only) of the ability to asynchronously create, update or delete items in Orgvue by providing a resource location payload to our endpoint.

v1 (2022-12-16)​

  • Early access preview (API reference only) of the ability to set gzip compression for our POST export endpoint. You can set the encoding query parameter that encodes the result of the export.

v1 (2022-12-16)​

  • Early access preview (API reference only) of the ability to control the line endings for TSV and CSV exports. This will be possible by means of the lineEndings query parameter, for our POST and GET export endpoints.

v1 (2022-12-09)​

  • Early access preview (API reference only) of the ability to control the injection of a Byte Order Mark for TSV and CSV exports. This will be possible by means of the includeBOM boolean query parameter, for our POST and GET export endpoints.
  • Early access preview (API reference only) of the ability to use dates in export queries. You can provide your dates in one of the supported date formats.

v1 (2022-12-05)​

Early access preview (API reference only) of an endpoint that allows items to be created, updated or deleted.

Supported:

  • CRUD updates.
  • Identifying the items to update by their Orgvue unique identifier, or one or more unique identifiers of your own choice.
  • Bulk item updates.

Not supported:

  • Calculated updates (such as update based on an existing value; you must first export your data, calculate on your side, then update).

v1 (2022-10-28)​

  • Our export endpoint is now able to handle filter queries and projections to allow you to control the nodes and columns of the data export.

v1 (2022-09-26)​

  • The {tenantId}/datasets/{datasetId} endpoint for retrieving a specific dataset resource with metadata has been moved out of "preview".
  • The above endpoint now returns additional metadata, including details of all user properties. The full specification is described in the API Reference section.

v1 (2022-09-20)​

Notice of deprecation

As we are still in Beta access there are some changes that under "stable API" circumstances would be breaking:

  • The /views/{viewId}/export endpoint has been deprecated in favour of /datasets/{datasetId}/export. This endpoint will no longer support either GET or POST methods. Documentation around this endpoint has been removed.

v1 (2022-08-18)​

  • Early access preview (API reference only) of on-demand property calculation support. Assumes that your dataset is configured with one or more on-demand properties which perform meaningful calculations when evaluated in order. You can now pass the names of the on-demand properties to evaluate during export, in an otherwise optional key.

v1 (2022-08-09)​

  • Early access of bring-your-own-presigned url. The final result location where our API stores its calculation is provided, owned and managed by you.

Notice of deprecation

As we are still in early access beta and have some changes that under "stable API" circumstances would be breaking:

  • We have updated our asynchronous export API endpoint to separate the jobTicket location from the actual result location. You can poll the jobTicket until the job is "completed", at which point in time the result location will be revealed in the body of the jobTicket.

v1 (2022-07-28)​

  • Early access of exporting all datasets in a tenant is now ready to be used by customers.
  • Early access preview (API reference only) of bring-your-own-presigned url.

v1 (2022-07-08)​

  • The early access preview (API reference only) of exporting all datasets in a tenant has been updated.
  • The early access preview (API reference only) of retrieving an individual dataset resource is in place. It contains a section on how to export the linking relationships with other datasets (equally in preview).
  • Documentation has been added around the different http methods allowed by our export endpoints. Both export endpoints (/views/{viewId}/export and /datasets/{datasetId}/export) support GET and POST methods.
    • POST producing asynchronous job tickets and being the suggested integration for live customer usage.
    • Please only use GET if you are integrating in a restrictive environment like an Excel spreadsheet.

Notice of deprecation

As we are still in early access beta and have some changes that under "stable API" circumstances would be breaking:

  • The /views/{viewId}/export endpoint is being deprecated in favour of /datasets/{datasetId}/export. The two endpoints produce the same outcome with regards to their response type, we are however making this change as it is easier on the client side for you to provide the datasetId instead of the viewId. You can still use the old endpoint for the time being.

v1 (2022-07-07)​

Early access preview (API reference only) of exporting all datasets in a tenant.

v1 (2022-07-01)​

Early access preview (API reference only) of data export by specifying the dataset instead of the view parameter.

v1 (2022-06-27)​

Early access export data endpoint available for a select number of customers.

Supported:

  • Generated properties (e.g. span, depth)
  • Evaluated/calculated properties (includes support for lookup values used in property expression)

Currently not included:

  • Filtering
  • On-demand calculations
  • Links calculations

Please contact support@orgvue.com if you are an existing customer that is interested in integrating with our APIs.