artifacts

Get one artifact by ID. Pass type to say which kind of artifact artifact_id names.

A document, diagram, or folder is returned only if the API key's user can open it in Auctor, including files shared to them through restrictions and grants. Otherwise the request returns 403. An M2M token has no user, so it can get only files with no restriction on themselves or on any folder above them.

A document or diagram in the organization space also needs the user's organization role to allow downloading organization files, and a file role that allows downloading it. Otherwise the request returns 403 and no content. An M2M token gets 403 on every organization-space document and diagram.

These file-role checks apply only once file permissions are turned on for your organization. Until then, the request doesn't run them.

Returns 503 if file roles can't be read. Retry the request.

get/v2/artifacts/{artifact_id}

Request

  • Base URL
    https://api.getauctor.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.getauctor.com/v2/artifacts/{artifact_id}
  • Auth
    none declared

Path parameters

artifact_idstring required

Query parameters

type'session' | 'document' | 'diagram' | 'folder' required
id_typestring

Response

Successful Response

OR
OR
OR

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status