Create Project

Description

Create a new project specified by parameters in JSON payload. You need to be authenticated, see details about the authentication.

Request

HTTP Request

POST

https://secure.gooddata.com/gdc/projects/

HTTP Headers

Content-Type: application/json
Accept: application/json

Request Body

Following JSON payload should be sent to create a new project:

{
"project" : {
"content" : {
"guidedNavigation": 1
},
"meta" : {
"title" : "Test Project",
"summary" : "Testing Project",
"projectTemplate" : "TEMPLATE URI"
} }
}

Response

OK - 201 Created + URI of created Project:

{
   "uri" : "/gdc/projects/PROJECT_ID_"
}

Code example

$ curl --cookie cookies.txt \ --data-binary @- \ --header 'Accept: application/yaml' \ --header 'Content-Type: application/json' \ https://secure.gooddata.com/gdc/projects/ EOR {"project" : {"content" : {"guidedNavigation": 1},
"meta" : {"summary" : "Testing Project","title":"Test"}}}

---

List all Projects

Description

Get the list of existing projects for authenticated user.

Request

HTTP Request

GET

https://secure.gooddata.com/gdc/account/profile/PROFILE_ID/projects

HTTP Headers

Content-Type: application/json
Accept: application/json

Request Body

Empty body

Response

{
   "projects" : [
      {
         "project" : {
            "content" : {
               "guidedNavigation" : "1",
               "isPublic" : "0",
               "state" : "ENABLED"
            },
            "links" : {
               "roles" : "/gdc/projects/PROJECT_ID/roles",
               "ldm_thumbnail" : "/gdc/projects/PROJECT_ID/ldm?thumbnail=1",
               "userPermissions" : "/gdc/projects/PROJECT_ID_/users/PROFILE_ID/permissions",
               "userRoles" : "/gdc/projects/PROJECT_ID/users/PROFILE_ID/roles",
               "connectors" : "/gdc/projects/PROJECT_ID/connectors",
               "self" : "/gdc/projects/PROJECT_ID",
               "invitations" : "/gdc/projects/PROJECT_ID/invitations",
               "users" : "/gdc/projects/PROJECT_ID/users",
               "ldm" : "/gdc/projects/PROJECT_ID/ldm",
               "metadata" : "/gdc/md/PROKECT_ID",
               "publicartifacts" : "/gdc/projects/PROJECT_ID/publicartifacts",
               "templates" : "/gdc/md/PROJECT_ID/templates"
            },
            "meta" : {
               "created" : "YYYY-MM-DD HH:MM:SS",
               "summary" : "Project Summary",
               "updated" : "YYYY-MM-DD HH:MM:SS",
               "author" : "/gdc/account/profile/PROFILE_ID",
               "title" : "Your Project Name",
               "contributor" : "/gdc/account/profile/PROFILE_ID"
            }
         }
      } ]
}

---

Export Project

Description

Resource for export whole project. You can choose from several options (export with users, export with data).

Request

HTTP Request

POST

https://secure.gooddata.com/gdc/md/PROJECT_ID/maintenance/export

HTTP Headers

Content-Type: application/json
Accept: application/json

Request Body

Following JSON payload should be sent to export project:

{ "exportProject" : {
     "exportUsers" : "boolean",
     "exportData" : "boolean"
  }
}

Response

HTTP 200 OK Status

Token + URI of async process status resource for polling in JSON object:

{
   "exportArtifact" : {
      "status" : {
         "uri" : "/gdc/md/PROJECT_ID/etltask/TASK_ID"
      },
      "token" : "EXPORT_TOKEN"
   }
}

---

Import Project

Description

Resource for import exported project with stored token.

Request

HTTP Request

POST

https://secure.gooddata.com/gdc/md/PROJECT_ID/maintenance/import

HTTP Headers

Content-Type: application/json
Accept: application/json

Request Body

Following JSON payload should be sent to import the exported project from the Token:

{ 
"importProject" : {
  "token" : "TOKEN_STRING"
  }
}

Response

HTTP 200 OK Status

URI of the async process status resource for polling:

{
"uri" : "/gdc/md/PROJECT_ID/etltask/TASK_ID"
}