diff --git a/docs/index.html b/docs/index.html index 6b3cfbdb..4c3a5eb0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -12,413 +12,413 @@ margin: 0; } - -
logo
API docs by Redocly
logo
API docs by Redocly

DA Admin API (1.0-RC)

Download OpenAPI specification:

License: Apache 2.0

DA Admin API is used to manage Document Authoring content repositories.

-

Source

DA Admin API (1.0-RC)

Download OpenAPI specification:

License: Apache 2.0

DA Admin API is used to manage Document Authoring content repositories.

+

Source

The source API allows you to work directly with your content sources (Docs, Sheets, Media).

-

Get source content

Get source content

Get a content source from an organization.

+" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

Get a content source from an organization.

Important: For files, the path parameter must include the file extension (e.g., myfile.html, data.json). The full URL would be: /source/{org}/{repo}/myfile.html

-
Authorizations:
bearer
path Parameters
org
required
string

The organization.

-
repo
required
string

Name of the repository.

-
path
required
string

Path to the source content.

-

Responses

Response samples

Content type
<body>
+
Authorizations:
bearer
path Parameters
org
required
string

The organization.

+
repo
required
string

Name of the repository.

+
path
required
string

Path to the source content.

+

Responses

Response samples

Content type
<body>
   <header></header>
   <main>
     <div></div>
   </main>
 </body>
-

Create or replace source content

Create or replace source content

Create or replace a content source within an organization.

+" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

Create or replace a content source within an organization.

Accepts either a multipart/form-data body with the content in the data field, or a raw request body for text-based types (text/html, application/json).

+

The multipart/form-data body may also include an optional guid field. When the target +location does not already have a stored identifier, guid becomes the document identifier. +It must be a UUID. A guid that is not a UUID is rejected with a 400 response. When the +target already has a stored identifier that differs from guid, the request is rejected with +a 409 response. When omitted, the service generates a UUID.

Important: For files, the path parameter must include the file extension (e.g., myfile.html, data.json). For folders, omit the extension (e.g., myfolder).

-
Authorizations:
bearer
path Parameters
org
required
string

The organization.

-
repo
required
string

Name of the repository.

-
path
required
string

Path to the source content.

-
Request Body schema:
data
string <binary>

The content to store at the specified location.

-

Responses

Request samples

Content type
destination: '/aemsites/geometrixx/path/to/file.html'
-

Response samples

Content type
application/json
{}

Create source content

Authorizations:
bearer
path Parameters
org
required
string

The organization.

+
repo
required
string

Name of the repository.

+
path
required
string

Path to the source content.

+
Request Body schema:
data
string <binary>

The content to store at the specified location.

+
guid
string <uuid>

Optional client-supplied identifier for the document. When the target +location does not already have a stored identifier, this value becomes +the document identifier. It must be a UUID. A value that is not a UUID +is rejected with a 400 response. When the target already has a stored +identifier that differs from this value, the request is rejected with a +409 response. When omitted, the service generates a UUID.

+

Responses

Request samples

Content type
destination: '/aemsites/geometrixx/path/to/file.html'
+

Response samples

Content type
application/json
{}

Create source content

Create a content source within an organization.

+" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

Create a content source within an organization.

Accepts either a multipart/form-data body with the content in the data field, or a raw request body for text-based types (text/html, application/json).

+

The multipart/form-data body may also include an optional guid field. When the target +location does not already have a stored identifier, guid becomes the document identifier. +It must be a UUID. A guid that is not a UUID is rejected with a 400 response. When the +target already has a stored identifier that differs from guid, the request is rejected with +a 409 response. When omitted, the service generates a UUID.

Important: For files, the path parameter must include the file extension (e.g., myfile.html, data.json). For folders, omit the extension (e.g., myfolder). Examples:

@@ -515,24 +549,38 @@
  • File: /source/{org}/{repo}/myfile.html
  • Folder: /source/{org}/{repo}/myfolder
    • -
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    -
    repo
    required
    string

    Name of the repository.

    -
    path
    required
    string

    Path to the source content.

    -
    Request Body schema:
    data
    string <binary>

    The content to store at the specified location.

    -

    Responses

    Request samples

    Content type
    destination: '/aemsites/geometrixx/path/to/file.html'
-

    Response samples

    Content type
    application/json
    {}

    Delete source content

    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    +
    repo
    required
    string

    Name of the repository.

    +
    path
    required
    string

    Path to the source content.

    +
    Request Body schema:
    data
    string <binary>

    The content to store at the specified location.

    +
    guid
    string <uuid>

    Optional client-supplied identifier for the document. When the target +location does not already have a stored identifier, this value becomes +the document identifier. It must be a UUID. A value that is not a UUID +is rejected with a 400 response. When the target already has a stored +identifier that differs from this value, the request is rejected with a +409 response. When omitted, the service generates a UUID.

    +

    Responses

    Request samples

    Content type
    destination: '/aemsites/geometrixx/path/to/file.html'
+

    Response samples

    Content type
    application/json
    {}

    Delete source content

    Delete the content source or directory.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete the content source or directory.

    Important: The path parameter works as follows:

    • For files: Include the extension in the path (e.g., myfile.html)
      • @@ -550,23 +598,23 @@
    • Delete file: /source/{org}/{repo}/myfile.html
    • Delete folder: /source/{org}/{repo}/myfolder
    -
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    -
    repo
    required
    string

    Name of the repository.

    -
    path
    required
    string

    Path to the source content.

    -

    Responses

    Copy

    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    +
    repo
    required
    string

    Name of the repository.

    +
    path
    required
    string

    Path to the source content.

    +

    Responses

    Copy

    The copy API allows you to copy a directory or source.

    -

    Copy source content

    Copy source content

    Copy a content source within an organization.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Copy a content source within an organization.

    Important: The path parameter works as follows:

    • For files: Include the extension in the path (e.g., myfile.html)
      • @@ -584,26 +632,26 @@
    • Copy file: /copy/{org}/{repo}/myfile.html
    • Copy folder: /copy/{org}/{repo}/myfolder
    -
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    -
    repo
    required
    string

    Name of the repository.

    -
    path
    required
    string

    Path to the source content.

    -
    Request Body schema: multipart/form-data
    destination
    string

    The destination path of the copy.

    -

    Responses

    Request samples

    Content type
    multipart/form-data
    destination: '/aemsites/geometrixx/path/to/file.html'
-

    Move

    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    +
    repo
    required
    string

    Name of the repository.

    +
    path
    required
    string

    Path to the source content.

    +
    Request Body schema: multipart/form-data
    destination
    string

    The destination path of the copy.

    +

    Responses

    Request samples

    Content type
    multipart/form-data
    destination: '/aemsites/geometrixx/path/to/file.html'
+

    Move

    The move API allows you to move a directory or source.

    -

    Move source content

    Move source content

    Move a content source within an organization.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Move a content source within an organization.

    Important: The path parameter works as follows:

    • For files: Include the extension in the path (e.g., myfile.html)
      • @@ -621,141 +669,153 @@
    • Move file: /move/{org}/{repo}/myfile.html
    • Move folder: /move/{org}/{repo}/myfolder
    -
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    -
    repo
    required
    string

    Name of the repository.

    -
    path
    required
    string

    Path to the source content.

    -
    Request Body schema: multipart/form-data
    destination
    string

    The destination path of the move.

    -

    Responses

    Request samples

    Content type
    multipart/form-data
    destination: '/aemsites/geometrixx/path/to/file.html'
-

    Version

    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    +
    repo
    required
    string

    Name of the repository.

    +
    path
    required
    string

    Path to the source content.

    +
    Request Body schema: multipart/form-data
    destination
    string

    The destination path of the move.

    +

    Responses

    Request samples

    Content type
    multipart/form-data
    destination: '/aemsites/geometrixx/path/to/file.html'
+

    Version

    The versionsource and versionlist APIs allow you to work with versions of source documents and sheets.

    -

    Get source version

    Get source version

    Returns version of a given source.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Returns version of a given source.

    Important: The guid parameter must include the file extension (e.g., version-123.html, v2.json). Example: /versionsource/{org}/{repo}/version-123.html

    -
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    -
    repo
    required
    string

    Name of the repository.

    -
    guid
    required
    string

    GUID of the version source.

    -

    Responses

    Response samples

    Content type
    <body>
+
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    +
    repo
    required
    string

    Name of the repository.

    +
    guid
    required
    string

    GUID of the version source.

    +

    Responses

    Response samples

    Content type
    <body>
   <header></header>
   <main>
     <div></div>
   </main>
 </body>
-

    Create source version

    Create source version

    Create a version of a given source.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create a version of a given source.

    Important: The path parameter must include the file extension (e.g., myfile.html, data.json). Example: /versionsource/{org}/{repo}/myfile.html

    -
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    -
    repo
    required
    string

    Name of the repository.

    -
    path
    required
    string

    Path to the source content.

    -

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    List source versions

    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    +
    repo
    required
    string

    Name of the repository.

    +
    path
    required
    string

    Path to the source content.

    +

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    List source versions

    Returns a list of versions for a given source.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Returns a list of versions for a given source.

    Important: The path parameter must include the file extension (e.g., myfile.html, data.json). Example: /versionlist/{org}/{repo}/myfile.html

    -
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    -
    repo
    required
    string

    Name of the repository.

    -
    path
    required
    string

    Path to the source content.

    -

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    List

    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    +
    repo
    required
    string

    Name of the repository.

    +
    path
    required
    string

    Path to the source content.

    +

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    List

    The list API will list children of a directory.

    -

    List sources

    Returns a list of sources from an organization.

    -
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    -
    repo
    required
    string

    Name of the repository.

    -
    path
    required
    string

    Path to the source content.

    -
    header Parameters
    da-continuation-token
    string

    Continuation token from the previous list response header.

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "sources": [
      ]
    }

    Config

    List sources

    Returns a list of sources from an organization.

    +
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    +
    repo
    required
    string

    Name of the repository.

    +
    path
    required
    string

    Path to the source content.

    +
    header Parameters
    da-continuation-token
    string

    Continuation token from the previous list response header.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "sources": [
      ]
    }

    Config

    The config API will allow you to associate sheet-formatted configurations with orgs, sites, directories, documents, and sheets.

    -

    Config

    Get a config for an org, repo, or source.

    -
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    -
    repo
    required
    string

    Name of the repository.

    -
    path
    required
    string

    Path to the source content.

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "total": 0,
    • "limit": 0,
    • "offset": 0,
    • "data": [
      ],
    • ":type": "string"
    }

    New config

    Create a config for an org, repo, or source.

    -
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    -
    repo
    required
    string

    Name of the repository.

    -
    path
    required
    string

    Path to the source content.

    -
    Request Body schema: multipart/form-data
    data
    string <binary>

    The content to store at the specified location.

    -

    Responses

    Request samples

    Content type
    multipart/form-data
    destination: '/aemsites/geometrixx/path/to/file.html'
-

    Response samples

    Content type
    application/json
    {}
    +

    Config

    Get a config for an org, repo, or source.

    +
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    +
    repo
    required
    string

    Name of the repository.

    +
    path
    required
    string

    Path to the source content.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "total": 0,
    • "limit": 0,
    • "offset": 0,
    • "data": [
      ],
    • ":type": "string"
    }

    New config

    Create a config for an org, repo, or source.

    +
    Authorizations:
    bearer
    path Parameters
    org
    required
    string

    The organization.

    +
    repo
    required
    string

    Name of the repository.

    +
    path
    required
    string

    Path to the source content.

    +
    Request Body schema: multipart/form-data
    data
    string <binary>

    The content to store at the specified location.

    +
    guid
    string <uuid>

    Optional client-supplied identifier for the document. When the target +location does not already have a stored identifier, this value becomes +the document identifier. It must be a UUID. A value that is not a UUID +is rejected with a 400 response. When the target already has a stored +identifier that differs from this value, the request is rejected with a +409 response. When omitted, the service generates a UUID.

    +

    Responses

    Request samples

    Content type
    multipart/form-data
    destination: '/aemsites/geometrixx/path/to/file.html'
+

    Response samples

    Content type
    application/json
    {}