--- title: "Release" description: "Explore comprehensive release management with our API documentation. Learn about creating, updating, and archiving releases. (Gitana 4.0)" product: "Gitana" version: "4.0" url: "/documentation/gitana/4.0/reference/types/release" --- # Release An Object 1. [Platform](/documentation/gitana/4.0/reference/types/platform.md) 2. [Repository](/documentation/gitana/4.0/reference/types/repository.md) 3. [Release](/documentation/gitana/4.0/reference/types/release.md) ##### Table of Contents - [Overview](#top "Overview") - [Parent](#parent "Parent") - [Properties](#properties "Properties") - [Methods](#methods "Methods") - [Schema](#schema "Schema") > **Note:** Drop in one of our language drivers to accelerate your development. > Here are links to some of our popular [Cookbooks](/documentation/gitana/4.0/developers/cookbooks/overview.md) to help you get started! > > - [C#](/documentation/gitana/4.0/developers/cookbooks/csharp.md) > - [Go](/documentation/gitana/4.0/developers/cookbooks/go.md) > - [Java](/documentation/gitana/4.0/developers/cookbooks/java.md) > - [JavaScript](/documentation/gitana/4.0/developers/cookbooks/javascript2.md) > - [PHP](/documentation/gitana/4.0/developers/cookbooks/php.md) > - [Python](/documentation/gitana/4.0/developers/cookbooks/python.md) > - [Ruby](/documentation/gitana/4.0/developers/cookbooks/ruby.md) ## Parent This Release is contained within a [Repository](/documentation/gitana/4.0/reference/types/repository.md). ## 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 | ## Methods The following methods are available: - [Archive Release](#post-repositories-repositoryid-releases-releaseid-archive "Archive Release") - [Check Permission](#post-repositories-repositoryid-releases-releaseid-permissions-permissionid-check "Check Permission") - [Check Single Authority](#post-repositories-repositoryid-releases-releaseid-authorities-authorityid-check "Check Single Authority") - [Check multiple Authorities](#post-repositories-repositoryid-releases-authorities-check "Check multiple Authorities") - [Check multiple Permissions](#post-repositories-repositoryid-releases-permissions-check "Check multiple Permissions") - [Create Release](#post-repositories-repositoryid-releases "Create Release") - [Delete Release](#delete-repositories-repositoryid-releases-releaseid "Delete Release") - [Delete Release](#post-repositories-repositoryid-releases-releaseid-delete "Delete Release") - [Export Release](#post-repositories-repositoryid-releases-releaseid-export "Export Release") - [Finalize Release](#post-repositories-repositoryid-releases-releaseid-finalize "Finalize Release") - [Grant Authority](#post-repositories-repositoryid-releases-releaseid-authorities-authorityid-grant "Grant Authority") - [Import Release](#post-repositories-repositoryid-releases-releaseid-import "Import Release") - [Lists Release](#get-repositories-repositoryid-releases "Lists Release") - [Network Releases](#post-repositories-repositoryid-releases-network "Network Releases") - [Queries for Release](#post-repositories-repositoryid-releases-query "Queries for Release") - [Read ACL](#get-repositories-repositoryid-releases-releaseid-acl-list "Read ACL") - [Read ACL for Principal](#get-repositories-repositoryid-releases-releaseid-acl "Read ACL for Principal") - [Read Authorities Report](#post-repositories-repositoryid-releases-releaseid-authorities "Read Authorities Report") - [Read Info Release](#get-repositories-repositoryid-releases-releaseid-info "Read Info Release") - [Read Release](#get-repositories-repositoryid-releases-releaseid "Read Release") - [Releaseimmediately Release](#post-repositories-repositoryid-releases-releaseid-releaseimmediately "Releaseimmediately Release") - [Revoke Authority](#post-repositories-repositoryid-releases-releaseid-authorities-authorityid-revoke "Revoke Authority") - [Start Create](#post-repositories-repositoryid-releases-create-start "Start Create") - [Start Finalize](#post-repositories-repositoryid-releases-releaseid-finalize-start "Start Finalize") - [Unarchive Release](#post-repositories-repositoryid-releases-releaseid-unarchive "Unarchive Release") - [Unfinalize Release](#post-repositories-repositoryid-releases-releaseid-unfinalize "Unfinalize Release") - [Update Release](#put-repositories-repositoryid-releases-releaseid "Update Release") - [Update Release](#post-repositories-repositoryid-releases-releaseid-update "Update Release") ### Archive Release POST /repositories/{repositoryId}/releases/{releaseId}/archive #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | ### Check Permission Checks whether one or more authorities against the specified release are granted for a given set of users POST /repositories/{repositoryId}/releases/{releaseId}/permissions/{permissionId}/check #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | | permissionId | true | string | The ID of the permission | | id | true | string | | #### Response ```json { "$ref": "#/components/schemas/checkPermission" } ``` ### Check Single Authority Checks whether a single authority is granted against the specified release for the given user POST /repositories/{repositoryId}/releases/{releaseId}/authorities/{authorityId}/check #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | | authorityId | true | string | The ID or authority key for the authority | | id | true | string | | #### Response ```json { "type": "object", "description": "Check", "extends": "status", "properties": { "check": { "type": "boolean" }, "ok": null } } ``` ### Check multiple Authorities Checks whether one or more authorities against the specified release are granted for a given set of users POST /repositories/{repositoryId}/releases/authorities/check #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | #### Response ```json { "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 release are granted for a given set of users POST /repositories/{repositoryId}/releases/permissions/check #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | #### Response ```json { "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" } } } } } } ``` ### Create Release Creates a new Release POST /repositories/{repositoryId}/releases #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | sourceId | false | string | | #### Response ```json { "type": "object", "description": "Status of Operation", "properties": { "ok": { "type": "boolean", "description": "Indicates whether the operation succeeded or not" } } } ``` ### Delete Release Deletes an existing Release DELETE /repositories/{repositoryId}/releases/{releaseId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | #### Response ```json { "type": "object", "description": "Status of Operation", "properties": { "ok": { "type": "boolean", "description": "Indicates whether the operation succeeded or not" } } } ``` ### Delete Release Deletes an existing Release POST /repositories/{repositoryId}/releases/{releaseId}/delete #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | #### Response ```json { "type": "object", "description": "Status of Operation", "properties": { "ok": { "type": "boolean", "description": "Indicates whether the operation succeeded or not" } } } ``` ### Export Release Starts an export job for this resource POST /repositories/{repositoryId}/releases/{releaseId}/export #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | 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 ```json { "type": "object", "description": "Export Configuration", "properties": { "startDate": { "type": "object", "description": "Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports." }, "endDate": { "type": "object", "description": "Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports." }, "startChangeset": { "type": "string", "description": "Only include data that is relevant to changesets at or beyond the specified changeset." }, "endChangeset": { "type": "string", "description": "Only include data that is relevant to changesets at or before the specified changeset." }, "includeACLs": { "type": "boolean", "default": true, "description": "Whether to include ACLs during export." }, "includeTeams": { "type": "boolean", "default": true, "description": "Whether to include Teams during export." }, "includeActivities": { "type": "boolean", "default": true, "description": "Whether to include Activities during export." }, "includeBinaries": { "type": "boolean", "default": true, "description": "Whether to include Binaries for data stores during export." }, "includeAttachments": { "type": "boolean", "default": true, "description": "Whether to include Attachments for Attachables during export." }, "artifactDependencies": { "type": "array", "items": { "type": "object" } }, "artifactIncludes": { "type": "array", "items": { "type": "object" } }, "forceIncludes": { "type": "boolean" } } } ``` ### Finalize Release POST /repositories/{repositoryId}/releases/{releaseId}/finalize #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | ### Grant Authority Grants an authority against the specified release to a given user POST /repositories/{repositoryId}/releases/{releaseId}/authorities/{authorityId}/grant #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | | authorityId | true | string | The ID or authority key for the authority | | id | true | string | | #### Response ```json { "type": "object", "description": "Status of Operation", "properties": { "ok": { "type": "boolean", "description": "Indicates whether the operation succeeded or not" } } } ``` ### Import Release Starts an import job for this resource POST /repositories/{repositoryId}/releases/{releaseId}/import #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | 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 ```json { "type": "object", "description": "Import Configuration", "properties": { "includeACLs": { "type": "boolean", "default": true, "description": "Whether to include ACLs during import." }, "includeTeams": { "type": "boolean", "default": true, "description": "Whether to include Teams during import." }, "includeActivities": { "type": "boolean", "default": true, "description": "Whether to include Activities during import." }, "includeBinaries": { "type": "boolean", "default": true, "description": "Whether to include Binaries for data stores during import." }, "includeAttachments": { "type": "boolean", "default": true, "description": "Whether to include Attachments for Attachables during import." }, "strategy": { "type": "array", "items": { "type": "string" }, "default": "CLONE", "description": "Either CLONE or COPY_EVERYTHING. Use CLONE to keep the same IDs on import. Use COPY_EVERYTHING to generate all new IDs for all entries on every import." }, "substitutions": { "type": "string" } } } ``` ### Lists Release Retrieves a list of Release instances GET /repositories/{repositoryId}/releases #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | 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 | This method supports pagination. #### Response ```json { "type": "object", "description": "Result Map", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/resultmap_release" } } } } ``` ### Network Releases POST /repositories/{repositoryId}/releases/network #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | ### Queries for Release Queries for instances of type Release POST /repositories/{repositoryId}/releases/query #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | 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 | This method supports pagination. #### Response ```json { "type": "object", "description": "Result Map", "properties": { "total_rows": { "type": "number" }, "offset": { "type": "number" }, "size": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/resultmap_release" } } } } ``` ### Read ACL Read the Access Control List for the specified release GET /repositories/{repositoryId}/releases/{releaseId}/acl/list #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | #### Response ```json { "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 Reads the ACL for a release and specific actor GET /repositories/{repositoryId}/releases/{releaseId}/acl #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | | id | true | string | | #### Response ```json { "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 Authorities Report Read the Authorities Report for the specified release POST /repositories/{repositoryId}/releases/{releaseId}/authorities #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | #### Response ```json { "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" } } } } } } } } } ``` ### Read Info Release GET /repositories/{repositoryId}/releases/{releaseId}/info #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | ### Read Release Reads an instance of a Release GET /repositories/{repositoryId}/releases/{releaseId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | #### Response ```json { "type": "object", "extends": "document", "description": "Release", "container": "repository", "properties": { "_doc": null, "_system": null } } ``` ### Releaseimmediately Release POST /repositories/{repositoryId}/releases/{releaseId}/releaseimmediately #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | ### Revoke Authority Revokes an authority against the specified release from a given user POST /repositories/{repositoryId}/releases/{releaseId}/authorities/{authorityId}/revoke #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | | authorityId | true | string | The ID or authority key for the authority | | id | true | string | | #### Response ```json { "type": "object", "description": "Status of Operation", "properties": { "ok": { "type": "boolean", "description": "Indicates whether the operation succeeded or not" } } } ``` ### Start Create POST /repositories/{repositoryId}/releases/create/start #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | sourceId | false | string | | ### Start Finalize POST /repositories/{repositoryId}/releases/{releaseId}/finalize/start #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | ### Unarchive Release POST /repositories/{repositoryId}/releases/{releaseId}/unarchive #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | ### Unfinalize Release POST /repositories/{repositoryId}/releases/{releaseId}/unfinalize #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | ### Update Release Updates an existing Release PUT /repositories/{repositoryId}/releases/{releaseId} #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | #### Response ```json { "type": "object", "description": "Status of Operation", "properties": { "ok": { "type": "boolean", "description": "Indicates whether the operation succeeded or not" } } } ``` ### Update Release Updates an existing Release POST /repositories/{repositoryId}/releases/{releaseId}/update #### Parameters | Name | Required | Type | Description | | --- | --- | --- | --- | | repositoryId | true | string | The ID of the repository | | releaseId | true | string | | #### Response ```json { "type": "object", "description": "Status of Operation", "properties": { "ok": { "type": "boolean", "description": "Indicates whether the operation succeeded or not" } } } ``` ## Schema ```json { "type": "object", "extends": "document", "description": "Release", "container": "repository", "properties": { "_doc": null, "_system": null }, "id": "release" } ```