diff --git a/docs/index.html b/docs/index.html index 0ba56e75..deb273c4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -12,383 +12,407 @@ margin: 0; } - -
logo
API docs by Redocly
logo
API docs by Redocly

DA Admin API (1.0-RC)

Download OpenAPI specification:Download

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 a content source 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.

-
ext
required
string

The source content file extension.

-

Responses

Response samples

Content type
<body>
+

Get source content

Get a content source 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.

+
ext
required
string

The source content file extension.

+

Responses

Response samples

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

Create source content

Create a content source within 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.

-
ext
required
string

The source content file extension.

-
Request Body schema: multipart/form-data
data
blob

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
{}

Delete source content

Delete the content source or directory.

-
Authorizations:
bearer
path Parameters
org
required
string

The organization.

-
repo
required
string

Name of the repository.

-
path
required
string

Path to the source content.

-
ext
string

The source content file extension.

-

Responses

Copy

Create source content

Create a content source within 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.

+
ext
required
string

The source content file extension.

+
Request Body schema: multipart/form-data
data
blob

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
{}

Delete source content

Delete the content source or directory.

+
Authorizations:
bearer
path Parameters
org
required
string

The organization.

+
repo
required
string

Name of the repository.

+
path
required
string

Path to the source content.

+
ext
string

The source content file extension.

+

Responses

Copy

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

-

Copy source content

Copy a content source within 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.

-
ext
string

The source content file extension.

-
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

Copy source content

Copy a content source within 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.

+
ext
string

The source content file extension.

+
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 a content source within 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.

-
ext
string

The source content file extension.

-
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

Move source content

Move a content source within 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.

+
ext
string

The source content file extension.

+
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

Returns version of a given source.

-
Authorizations:
bearer
path Parameters
org
required
string

The organization.

-
repo
required
string

Name of the repository.

-
guid
required
string

GUID of the version source.

-
ext
required
string

The source content file extension.

-

Responses

Response samples

Content type
<body>
+

Get source version

Returns version of a given source.

+
Authorizations:
bearer
path Parameters
org
required
string

The organization.

+
repo
required
string

Name of the repository.

+
guid
required
string

GUID of the version source.

+
ext
required
string

The source content file extension.

+

Responses

Response samples

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

Create source version

Create a version of a given 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.

-
ext
required
string

The source content file extension.

-

Responses

List source versions

Returns a list of versions for a given 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.

-
ext
required
string

The source content file extension.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List

Create source version

Create a version of a given 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.

+
ext
required
string

The source content file extension.

+

Responses

List source versions

Returns a list of versions for a given 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.

+
ext
required
string

The source content file extension.

+

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.

-

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.

+

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
path
required
string

Path to the source content.

-

Responses

New config

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

-
Authorizations:
bearer
path Parameters
path
required
string

Path to the source content.

-
Request Body schema: multipart/form-data
data
blob

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
path
required
string

Path to the source content.

+

Responses

New config

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

+
Authorizations:
bearer
path Parameters
path
required
string

Path to the source content.

+
Request Body schema: multipart/form-data
data
blob

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
{}