GAgatana
artifacts

PATCH /artifacts/{artifactId}

Changed on

Change the title, visibility or theme of an artifact without touching its content

Request

  • Base URL
    https://YOUR_ORG_ID.gatana.ai/api/v1
  • URL
    https://YOUR_ORG_ID.gatana.ai/api/v1/artifacts/{artifactId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /oauth/authorize
      Token URL: /oauth/token

Path parameters

artifactIdstring required

Request body

titlestring
visibility'private' | 'tenant' | 'public'
themestring

'gatana' (Gatana styling), 'none' (the document as published), or an organization theme by id or by name

Response

Successful response

idstring required
titlestring required
createdByUserIdstring required
createdByUserNamestring required

Display name of the creator, empty when no name is set

createdByUserEmailstring required

Email of the creator

visibility'private' | 'tenant' | 'public' required
themestring required

The theme the artifact is served with: 'gatana', 'none', or the id of an organization theme

currentVersionnumber required
sharedWithUserIdsSchema1264[] required

IDs of the users the artifact is shared with

sharedWithTeamIdsSchema1266[] required

IDs of the teams the artifact is shared with

createdAtstring required
updatedAtstring required
urlstring required

The viewer URL of the artifact on the tenant domain

Changes

  • 8bae1eeac593Revision changes
    • info

      removed the gatana enum value from the response property for the response status

    • info

      removed the none enum value from the response property for the response status