Archive

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Archive is contained within a Vault.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
artifact string No
childrenOnly boolean No
contents object No
dependencies object No
endChangeset string No
endDate object No
group string No
includes object No
model string No
sources object No
startChangeset string No
startDate object No
template object No
type string No
version string No

Methods

The following methods are available:

Archives

POST /vaults/{vaultId}/archives

Parameters

Name Required Type Description
vaultId true string The ID of the vault
group false string
artifact false string
version false string
type false string
title false string
description false string
published false string

Response

{}

Attachments

GET /vaults/{vaultId}/archives/{archiveId}/attachments

Parameters

Name Required Type Description
vaultId true string
archiveId true string

Response

{}

Attachments

POST /vaults/{vaultId}/archives/{archiveId}/attachments

Parameters

Name Required Type Description
vaultId true string
archiveId true string

Response

{}

Check Permission

Checks whether one or more authorities against the specified archive are granted for a given set of users
POST /vaults/{vaultId}/archives/{archiveId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
vaultId true string
archiveId true string
permissionId true string
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified archive for the given user
POST /vaults/{vaultId}/archives/{archiveId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
vaultId true string
archiveId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified archive are granted for a given set of users
POST /vaults/{vaultId}/archives/authorities/check

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified archive are granted for a given set of users
POST /vaults/{vaultId}/archives/permissions/check

Parameters

Name Required Type Description
vaultId true string

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Copy

GET /vaults/{vaultId}/archives/{archiveId}/copy

Parameters

Name Required Type Description
vaultId true string The ID of the vault
archiveId true string The ID of the archive
targetVaultId true string

Response

{}

Delete Archive

Deletes an existing Archive
DELETE /vaults/{vaultId}/archives/{archiveId}

Parameters

Name Required Type Description
vaultId true string
archiveId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Download

GET /vaults/{vaultId}/archives/download

Parameters

Name Required Type Description
vaultId true string The ID of the vault
groupId true string The ID of the group
artifactId true string
versionId true string

Response

{}

Download

GET /vaults/{vaultId}/archives/{archiveId}/download

Parameters

Name Required Type Description
vaultId true string The ID of the vault
archiveId true string The ID of the archive

Response

{}

Grant Authority

Grants an authority against the specified archive to a given user
POST /vaults/{vaultId}/archives/{archiveId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
vaultId true string
archiveId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Lookup

GET /vaults/{vaultId}/archives/lookup

Parameters

Name Required Type Description
vaultId true string
group true string
artifact true string
version true string

Response

{}

Publish

POST /vaults/{vaultId}/archives/{archiveId}/publish

Parameters

Name Required Type Description
vaultId true string The ID of the vault
archiveId true string The ID of the archive

Response

{}

Queries for Archive

Queries for instances of type Archive
POST /vaults/{vaultId}/archives/query

Parameters

Name Required Type Description
vaultId true string
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_archive"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified archive
GET /vaults/{vaultId}/archives/{archiveId}/acl/list

Parameters

Name Required Type Description
vaultId true string
archiveId true string

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Read the Access Control List for the specified archive and the given principal
GET /vaults/{vaultId}/archives/{archiveId}/acl

Parameters

Name Required Type Description
vaultId true string
archiveId true string
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Archive

Reads an instance of a Archive
GET /vaults/{vaultId}/archives/{archiveId}

Parameters

Name Required Type Description
vaultId true string
archiveId true string

Response

{
  "description": "Archive",
  "container": "vault",
  "type": "object",
  "extends": "document",
  "properties": {
    "model": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "group": {
      "type": "string"
    },
    "artifact": {
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "contents": {
      "type": "object"
    },
    "dependencies": {
      "type": "object"
    },
    "includes": {
      "type": "object"
    },
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "sources": {
      "type": "object"
    },
    "childrenOnly": {
      "type": "boolean"
    },
    "template": {
      "type": "object",
      "properties": {
        "templateType": {
          "type": "string"
        },
        "templateKey": {
          "type": "string"
        }
      }
    },
    "_doc": null,
    "_system": null
  }
}

Read Authorities Report

Read the Authorities Report for the specified archive
POST /vaults/{vaultId}/archives/{archiveId}/authorities

Parameters

Name Required Type Description
vaultId true string
archiveId true string

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Revoke Authority

Revokes an authority against the specified archive from a given user
POST /vaults/{vaultId}/archives/{archiveId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
vaultId true string
archiveId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Starts an export job for this resource

Starts an export job for this resource
POST /vaults/{vaultId}/archives/{archiveId}/export

Parameters

Name Required Type Description
vaultId true string
archiveId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

Starts an import job for this resource
POST /vaults/{vaultId}/archives/{archiveId}/import

Parameters

Name Required Type Description
vaultId true string
archiveId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Unpublish

POST /vaults/{vaultId}/archives/{archiveId}/unpublish

Parameters

Name Required Type Description
vaultId true string The ID of the vault
archiveId true string The ID of the archive

Response

{}

Update Archive

Updates an existing Archive
PUT /vaults/{vaultId}/archives/{archiveId}

Parameters

Name Required Type Description
vaultId true string
archiveId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Archive

Updates an existing Archive
POST /vaults/{vaultId}/archives/{archiveId}/update

Parameters

Name Required Type Description
vaultId true string
archiveId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

{attachmentId}

GET /vaults/{vaultId}/archives/{archiveId}/attachments/{attachmentId}

Parameters

Name Required Type Description
vaultId true string
archiveId true string
attachmentId true string

Response

{}

{attachmentId}

DELETE /vaults/{vaultId}/archives/{archiveId}/attachments/{attachmentId}

Parameters

Name Required Type Description
vaultId true string
archiveId true string
attachmentId true string

Response

{}

{attachmentId}

POST /vaults/{vaultId}/archives/{archiveId}/attachments/{attachmentId}

Parameters

Name Required Type Description
vaultId true string
archiveId true string
attachmentId true string

Response

{}

{name}

GET /vaults/{vaultId}/archives/{archiveId}/preview/{name}

Parameters

Name Required Type Description
vaultId true string
archiveId true string
name true string

Response

{}

Schema


{
  "description": "Archive",
  "container": "vault",
  "type": "object",
  "extends": "document",
  "properties": {
    "model": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "group": {
      "type": "string"
    },
    "artifact": {
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "contents": {
      "type": "object"
    },
    "dependencies": {
      "type": "object"
    },
    "includes": {
      "type": "object"
    },
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "sources": {
      "type": "object"
    },
    "childrenOnly": {
      "type": "boolean"
    },
    "template": {
      "type": "object",
      "properties": {
        "templateType": {
          "type": "string"
        },
        "templateKey": {
          "type": "string"
        }
      }
    },
    "_doc": null,
    "_system": null
  },
  "id": "archive"
}