Chime API Documentation

Projects

Table of contents:

List projects

Returns all projects in the account.

Resource URL
GET
/projects
Example
Request
GET
https://pickles.getchime.com/api/projects?status=ACTIVE&mine=1
GET Parameters
Name Description
status String ACTIVE or ARCHIVED
mine Integer 1 or 0
Sample Response
{
    "success": true,
    "data": [
        {
            "id": 16,
            "name": "all_members_repo"
        },
        {
            "id": 5,
            "name": "closed_repo"
        },
        {
            "id": 25,
            "name": "git_branch"
        },
        {
            "id": 10,
            "name": "git_empty_repo"
        },
        {
            "id": 27,
            "name": "git_large_repo"
        },
        {
            "id": 8,
            "name": "git_repo"
        },
        {    
            "id": 9,
            "name": "svn_empty_repo"
        },
        {
            "id": 26,
            "name": "svn_large_repo"
        },
        {
            "id": 22,
            "name": "svn_pegrevision"
        },
        {
            "id": 7,
            "name": "svn_repo"
        },
    ]
}

Get

Returns a single project.

Resource URL
GET
/project/:projectId
Example
Request
GET
https://pickles.getchime.com/api/project/8
URL Parameters
Name Description
projectId integer The numerical ID of the desired project.
Sample Response
{
    "success": true,
    "data": {
        "id": 8,
        "name": "git_repo",
        "status": "ACTIVE",
        "modules": [
            "TIME_TRACKING",
            "SOURCE",
            "MESSAGES",
            "TICKETS",
            "DEPLOY",
            "WIKI"
        ],
        "currentDiskUsed": 1,
        "repositoryType": "GIT",
        "sshRepositoryUrl": "ssh://sls@slsapp.com:1234/pickles/git_repo.git",
        "httpRepositoryUrl": "https://slsapp.com/git/pickles/git_repo.git",
        "ticketStatusWorkflow": {
            "id": 1,
            "name": "Extended"
        },
        "owner": {
            "id": 9,
            "shortName": "Owner L.",
            "firstName": "Owner",
            "lastName": "Lastname"
        }
    }
}

Add project

Creates a new project.

Resource URL
POST
/projects
Example
Request
POST
https://pickles.getchime.com/api/projects
POST parameters
Name Description
name Required string The name of new project.
modules Required array of strings Modules, which will be active in project. Available values: SOURCE, DEPLOY, TASKS, WIKI, TIME_TRACKING
repositoryType Required string GIT or SVN.
standardLayout bool Only for repositoryType SVN.
tasksWorkflowId integer Workflow id if modules contains SOURCE.
Sample Request
{
  "modules": ["SOURCE", "DEPLOY", "TASKS", "WIKI", "TIME_TRACKING"],
  "name": "MyWebsite",
  "repositoryType": "SVN",
  "standardLayout": true,
  "tasksWorkflowId": 5
}
Sample Response
{
  "success": true,
  "data": {
    "id": 235,
    "name": "MyWebsite",
    "status": "ACTIVE",
    "modules": [
      "DEPLOY",
      "SOURCE",
      "TIME_TRACKING",
      "TICKETS",
      "WIKI"
    ],
    "currentDiskUsed": 0,
    "repositoryType": "SVN",
    "ticketStatusWorkflow": {
      "id": 1,
      "name": "Extended"
    },
    "owner": {
      "id": 4,
      "avatarSmall": "https://pickles.getchime.com/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/30/30/AVATAR.png",
      "avatarLarge": "https://pickles.getchime.com/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/60/60/AVATAR.png",
      "avatarMicro": "https://pickles.getchime.com/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/16/16/AVATAR.png",
      "shortName": "Owner L.",
      "firstName": "Owner",
      "lastName": "Lastname"
    }
  }
}

Get

Deletes a desired project.

Resource URL
DELETE
/project/:projectId
Example
Request
DELETE
https://pickles.getchime.com/api/project/8
URL Parameters
Name Description
projectId integer The numerical ID of the desired project.
Sample Response
{
    "success": true
}
Create a free account
Leave a message

Have a question about Chime or one of our apps? Leave a message here and we'll get back to you as soon as we can.