REST: Projects related api

Project related api

List projects

Path: /rest/projects

Type: GET

Parameters:

Name	Type	Value	Mandatory	Description
sorting	string	name, ~name	no	Sorting by entity field value. By default ordering direction is ascending. Use prefix '~' to produce result in descending order.

Example results:

{
   "items": [
       {
         "id":1,
         "name":"asd",
         "description":"asd",
         "projectManager":
         "asd",
         "links":[
             {
                 "href":"http://genesis.example.com/rest/projects/1",
                 "rel" : "self",
                 "type" : "application/vnd.griddynamics.genesis.Project+json",
                 "methods": ["get"]
             }
         ]
      }
   ], 
   "links":[
       {
           "href": "http://genesis.example.com/rest/projects",
           "rel": "self",
           "type": "application/vnd.griddynamics.genesis.Project+json",
           "methods": [
               "get",
               "post"
           ]
       }
   ]
}

Get project details

Path: /rest/projects/(projectId)

Type: GET

Path variables: projectId - projectId

Example results:

{
    id: 4,
    name: "Users",
    creator: "genesis",
    creationTime: 1359990891653,
    projectManager: "manager",
    isDeleted: false,
    links: [
        {
            "href": "http://genesis.example.com/rest/projects/4",
            "rel": "self",
            "type": "application/vnd.griddynamics.genesis.Project+json",
            "methods": [
                "get",
                "put",
                "delete"
            ]
        },
        {
            "href": "http://genesis.example.com/rest/projects/4/settings",
            "rel": "collection",
            "type": "application/vnd.griddynamics.genesis.SystemSettings+json",
            "methods": [
                "get"
            ]
        },
        {
            "href": "http://localhost:8081/rest/projects/4/envs",
            "rel": "collection",
            "type": "application/vnd.griddynamics.genesis.Environment+json",
            "methods": [
                "get",
                "post"
            ]
        }
    ]
}

Create project

Path: /rest/projects

Type: POST

Example results:

Error on creation (common result object):

{
    "isSuccess": false,
    "isNotFound": false,
    "variablesErrors" : {"fieldName": "Error message"},
    "compoundServiceErrors" : ["Error message 1", "Error message 2"]
}

Successful creation:

{
    "isSuccess": true,
    "result" : {
        "id": 1,
        "name" : "asd!",
        "description":"asd",
        "projectManager": "asd"
    }
}

Input data:

{"name":"asd!","description":"asd","projectManager":"asd"}

Request body is a single JSON map contains the following entries:

Entry name	Type	Mandatory	Description
name	String	Y	Name of the project
description	String	В	Description of the project
projectManager	String(for now)	Y	Person responsible for the project

Delete project

Path: /rest/projects/(projectId)

Type: DELETE

Example results: None

Update project

Path: /rest/projects/(projectId)

Type: PUT

Example results:

Error on update (common result object):

{
    "isSuccess": false,
    "isNotFound": false,
    "variablesErrors" : {"fieldName": "Error message"},
    "compoundServiceErrors" : ["Error message 1", "Error message 2"]
}

Successful creation:

{
    "isSuccess": true,
    "result" : {
        "id": 1,
        "name" : "asd!",
        "description":"asd",
        "projectManager": "asd"
    }
}

Request body:

Input data:

{"id":4,"name":"asd!","description":"asd","projectManager":"asd"}

Request body consists form a single JSON map contains the following entries:

Entry name	Type	Mandatory	Description
id	int	Y	Id of the project
name	String	Y	Name of the project
description	String	Y	Description of the project
projectManager	String	Y	Person responsible for the project