Retrieve Sandbox Data

• GET https://routecloud.telogis.com/v1/sandboxes/{sandbox_id}.
• Authentication required.
• Response body:
  • If aggregate=1 is specified, returns a problem_aggregates.
  • Otherwise, if envelope=1 is specified, returns a sandbox_at_revision_envelope.
  • Otherwise, returns a problem.

Retrieve the contents of the sandbox. The sandbox is always returned in canonical form.

URL Parameters

• {sandbox_id} - The id of the sandbox to retrieve.

Query Parameters

• revision={revision_number} - Optional. Retrieve the contents of the sandbox at a particular revision number.
• envelope=1 - Optional. If specified, a sandbox_at_revision_envelope (see below) is returned instead of a problem. This allows a client to atomically retrieve the latest revision contents and details, which enables them to work more robustly when multiple clients are writing to the same sandbox.
• aggregate=1 - Optional. If specified, a problem_aggregates object summarizing the sandbox is returned, instead of the full problem. Takes precedence over envelope=1. Fields relating to the calculated values of the sandbox are not included in the response. If these are required an evaluate should be used on the sandbox.

Status Codes

• 200 - Success.
• 401 - Authentication required.
• 403 - The authenticated user does not have permission to perform this action.
• 404 - The sandbox_id does not exist.

sandbox_at_revision_envelope

Name	Type	Description
sandbox	sandbox_response	Details about the sandbox at this revision.
snapshot	problem	The data contained within the sandbox at this revision.
snapshot_created_time	datetime	When this revision was created, in UTC.
snapshot_revision	integer	The revision number of this snapshot.
snapshot_tag	string	A string to identify the revision. Assigned by the client on creation.

See Also

• Sandboxes.