Project

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 Project is contained within a Platform.

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
projectType string No
stackId string No

Methods

The following methods are available:

Attachments

POST /projects/{projectId}/attachments

Parameters

Name Required Type Description
projectId true string

Response

{}

Attachments

GET /projects/{projectId}/attachments

Parameters

Name Required Type Description
projectId true string

Response

{}

Check Permission

Checks whether one or more authorities against the specified project are granted for a given set of users
POST /projects/{projectId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
projectId 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 project for the given user
POST /projects/{projectId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
projectId 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 project are granted for a given set of users
POST /projects/authorities/check

Parameters

This function has no parameters.

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 project are granted for a given set of users
POST /projects/permissions/check

Parameters

This function has no parameters.

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-content

POST /projects/{projectId}/copy-content

Parameters

Name Required Type Description
projectId true string The ID of the project

Response

{}

Create

POST /projects/{projectId}/workflow/create

Parameters

Name Required Type Description
projectId true string The ID of the project
modelId true string

Response

{}

Create Project

Creates a new Project
POST /projects

Parameters

Name Required Type Description
isProtected false boolean
exportTipChangesetOnly false boolean
exportSelectedBranchIds false string
autoPublish false boolean

Response

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

Delete Project

Deletes an existing Project
POST /projects/{projectId}/delete

Parameters

Name Required Type Description
projectId true string

Response

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

Delete Project

Deletes an existing Project
DELETE /projects/{projectId}

Parameters

Name Required Type Description
projectId true string

Response

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

Grant Authority

Grants an authority against the specified project to a given user
POST /projects/{projectId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
projectId 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"
    }
  }
}

Index

POST /projects/{projectId}/admin/collections/index

Parameters

Name Required Type Description
projectId true string The ID of the project

Response

{}

Invite

POST /projects/{projectId}/users/invite

Parameters

Name Required Type Description
projectId true string The ID of the project
id true string

Response

{}

Lists Project

Retrieves a list of Project instances
GET /projects

Parameters

Name Required Type Description
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_project"
      }
    }
  }
}

Maintenance

POST /projects/{projectId}/admin/maintenance

Parameters

Name Required Type Description
projectId true string The ID of the project

Response

{}

Projecttypes

GET /projecttypes

Parameters

This function has no parameters.

Response

{}

Queries for Project

Queries for instances of type Project
POST /projects/query

Parameters

Name Required Type Description
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_project"
      }
    }
  }
}

Query

Queries for matches
POST /projects/{projectId}/users/query

Parameters

Name Required Type Description
projectId true string The ID of the project
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"
      }
    }
  }
}

Query

Queries for matches
POST /projects/{projectId}/teams/query

Parameters

Name Required Type Description
projectId true string The ID of the project
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_team"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified project
GET /projects/{projectId}/acl/list

Parameters

Name Required Type Description
projectId 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

Reads the ACL for a project and specific actor
GET /projects/{projectId}/acl

Parameters

Name Required Type Description
projectId 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 Authorities Report

Read the Authorities Report for the specified project
POST /projects/{projectId}/authorities

Parameters

Name Required Type Description
projectId 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"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Project

Reads an instance of a Project
GET /projects/{projectId}

Parameters

Name Required Type Description
projectId true string

Response

{
  "type": "object",
  "extends": "document",
  "description": "Project",
  "container": "platform",
  "properties": {
    "stackId": {
      "type": "string"
    },
    "projectType": {
      "type": "string"
    },
    "_doc": null,
    "_system": null
  }
}

Retrieves API Keys for the given project

Retrieves API Keys for the given project
GET /projects/{projectId}/apikeys

Parameters

Name Required Type Description
projectId true string The ID of the project

Response

{}

Revoke Authority

Revokes an authority against the specified project from a given user
POST /projects/{projectId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
projectId 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"
    }
  }
}

Start

POST /projects/start

Parameters

Name Required Type Description
isProtected false boolean
exportTipChangesetOnly false boolean
exportSelectedBranchIds false string
autoPublish false boolean

Response

{}

Starts an export job for this resource

Starts an export job for this resource
POST /projects/{projectId}/export

Parameters

Name Required Type Description
projectId 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 /projects/{projectId}/import

Parameters

Name Required Type Description
projectId 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"
    }
  }
}

Update Project

Updates an existing Project
POST /projects/{projectId}/update

Parameters

Name Required Type Description
projectId true string

Response

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

Update Project

Updates an existing Project
PUT /projects/{projectId}

Parameters

Name Required Type Description
projectId true string

Response

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

Users

POST /projects/{projectId}/users

Parameters

Name Required Type Description
projectId true string The ID of the project

Response

{}

{attachmentId}

POST /projects/{projectId}/attachments/{attachmentId}

Parameters

Name Required Type Description
projectId true string
attachmentId true string

Response

{}

{attachmentId}

GET /projects/{projectId}/attachments/{attachmentId}

Parameters

Name Required Type Description
projectId true string
attachmentId true string

Response

{}

{attachmentId}

DELETE /projects/{projectId}/attachments/{attachmentId}

Parameters

Name Required Type Description
projectId true string
attachmentId true string

Response

{}

{name}

GET /projects/{projectId}/preview/{name}

Parameters

Name Required Type Description
projectId true string
name true string

Response

{}

{teamId}

GET /projects/{projectId}/teams/{teamId}

Parameters

Name Required Type Description
projectId true string The ID of the project
teamId true string

Response

{}

{userId}

DELETE /projects/{projectId}/users/{userId}

Parameters

Name Required Type Description
projectId true string The ID of the project
userId true string The ID of the user

Response

{}

{userId}

GET /projects/{projectId}/users/{userId}

Parameters

Name Required Type Description
projectId true string The ID of the project
userId true string The ID of the user

Response

{}

Schema


{
  "type": "object",
  "extends": "document",
  "description": "Project",
  "container": "platform",
  "properties": {
    "stackId": {
      "type": "string"
    },
    "projectType": {
      "type": "string"
    },
    "_doc": null,
    "_system": null
  },
  "id": "project"
}