API docs by Redocly

DXP File Storage REST API (2024-08-30T01:51:47Z)

Download OpenAPI specification:Download

File

/api/v2/file/{fileId}

This endpoint will return file info for a specific file.

Authorizations:
DXPAuthDXPSession
path Parameters
fileId
required
string

Responses

Response samples

Content type
application/json
{
  • "download": "string",
  • "access": "private",
  • "size": 0,
  • "virusScan": "quarantined",
  • "source": "string",
  • "contentType": "string",
  • "fileId": "string",
  • "updatedAt": "string"
}

/api/v2/file/{fileId}

This endpoint will delete a file.

Authorizations:
DXPAuthDXPSession
path Parameters
fileId
required
string

Responses

Response samples

Content type
application/json
{
  • "pollingUrl": "string",
  • "requestId": "string"
}

/api/v2/file/{fileId}

This endpoint will accept file data, and metadata and update an existing file.

Authorizations:
DXPAuthDXPSession
path Parameters
fileId
required
string
Request Body schema: application/json
required
access
string
Enum: "private" "public"
data
string
uploadType
string
Default: "direct"
Enum: "direct" "resumable"
source
string

Responses

Request samples

Content type
application/json
{
  • "access": "private",
  • "data": "string",
  • "uploadType": "direct",
  • "source": "string"
}

Response samples

Content type
application/json
{
  • "download": "string",
  • "access": "private",
  • "size": 0,
  • "virusScan": "quarantined",
  • "source": "string",
  • "contentType": "string",
  • "fileId": "string",
  • "updatedAt": "string"
}

/api/v2/file/{fileId}/extract POST

This endpoint will extract the contents of a compressed file into a directory.

Authorizations:
DXPAuthDXPSession
path Parameters
fileId
required
string
Request Body schema: application/json
required
access
required
string
Enum: "private" "public"
target
required
string

Responses

Request samples

Content type
application/json
{
  • "access": "private",
  • "target": "string"
}

Response samples

Content type
application/json
{
  • "pollingUrl": "string",
  • "requestId": "string"
}

/api/v2/file/{fileId}/download

This endpoint will return the actual file as a download attachment.

Authorizations:
DXPAuthDXPSession
path Parameters
fileId
required
string

Responses

/api/v2/status

This endpoint will return the status of a request.

Authorizations:
DXPAuthDXPSession
path Parameters
requestId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "requestId": "string",
  • "status": "string"
}

/api/v2/file

This endpoint will return file info

Authorizations:
DXPAuthDXPSession
query Parameters
source
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v2/file

This endpoint will create a file

Authorizations:
DXPAuthDXPSession
Request Body schema: application/json
required
access
required
string
Enum: "private" "public"
data
required
string
uploadType
string
Default: "direct"
Enum: "direct" "resumable"
source
required
string

Responses

Request samples

Content type
application/json
{
  • "access": "private",
  • "data": "string",
  • "uploadType": "direct",
  • "source": "string"
}

Response samples

Content type
application/json
{
  • "download": "string",
  • "access": "private",
  • "size": 0,
  • "virusScan": "quarantined",
  • "source": "string",
  • "contentType": "string",
  • "fileId": "string",
  • "updatedAt": "string"
}

Directory

/api/v2/directory

This method will return a list of directories.

Authorizations:
DXPAuthDXPSession
query Parameters
source
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v2/directory

This endpoint will create a directory.

Authorizations:
DXPAuthDXPSession
Request Body schema: application/json
required
access
string
Enum: "private" "public"
source
required
string

Responses

Request samples

Content type
application/json
{
  • "access": "private",
  • "source": "string"
}

Response samples

Content type
application/json
{
  • "access": "private",
  • "directories": [
    ],
  • "files": [
    ],
  • "directoryId": "string",
  • "source": "string",
  • "updatedAt": "string"
}

/api/v2/status

This endpoint will return the status of a request.

Authorizations:
DXPAuthDXPSession
path Parameters
requestId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "requestId": "string",
  • "status": "string"
}

/api/v2/directory/{directoryId}

This endpoint will return a directory, with direct descendants.

Authorizations:
DXPAuthDXPSession
path Parameters
directoryId
required
string

Responses

Response samples

Content type
application/json
{
  • "access": "private",
  • "directories": [
    ],
  • "files": [
    ],
  • "directoryId": "string",
  • "source": "string",
  • "updatedAt": "string"
}

/api/v2/directory/{directoryId}

This endpoint will remove a directory and its contents.

Authorizations:
DXPAuthDXPSession
path Parameters
directoryId
required
string

Responses

Response samples

Content type
application/json
{
  • "pollingUrl": "string",
  • "requestId": "string"
}

/api/v2/directory/{directoryId}

This method will accept info for a directory and update an existing directory.

Authorizations:
DXPAuthDXPSession
path Parameters
directoryId
required
string
Request Body schema: application/json
required
access
string
Enum: "private" "public"
cascadeAccess
boolean
source
string

Responses

Request samples

Content type
application/json
{
  • "access": "private",
  • "cascadeAccess": true,
  • "source": "string"
}

Response samples

Content type
application/json
{
  • "pollingUrl": "string",
  • "requestId": "string"
}

Status

/api/v2/status

This endpoint will return the status of a request.

Authorizations:
DXPAuthDXPSession
path Parameters
requestId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "requestId": "string",
  • "status": "string"
}