forked from GoodDingo/gooddata-api-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiary.apib
5694 lines (4686 loc) · 201 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
FORMAT: X-1A
HOST: https://secure.gooddata.com
#GoodData API Documentation
The GoodData API is based on REST principles, all you need to use it is your GoodData account. You must be authenticated and call HTTPs requests on the URLs listed below.
This documentation covers the core resources you can used to manipulate objects on the GoodData Platform. Review the information basic instructions if you are new to APIs.
>**Note:** Use your GoodData TESTING credentials for API calls. Please do not use your production credentials.
##Allowed HTTPs requests:
- `POST` - Creates or updates a resource
- `PUT` - Updates a resource
- `GET` - Retrieves a resource or list of resources
- `DELETE` - Delete a resource
##Typical Server Responses
- 200 `OK` - The request was successful (some API calls may return 201 instead).
- 201 `Created` - The request was successful and a resource was created.
- 204 `No Content` - The request was successful but there is no representation to return (that is, the response is empty).
- 400 `Bad Request` - The request could not be understood or was missing required parameters.
- 401 `Unauthorized` - Authentication failed or user does not have permissions for the requested operation.
- 403 `Forbidden` - Access denied.
- 404 `Not Found` - Resource was not found.
- 405 `Method Not Allowed` - Requested method is not supported for the specified resource.
- 429 `Too Many Requests` - Exceeded GoodData API limits. Pause requests, wait one minute, and try again.
- 503 `Service Unavailable` - The service is temporary unavailable (e.g. scheduled Platform Maintenance). Try again later.
# Group Platform Availability
<a id="available" ></a>
If The GoodData Platform is in scheduled maintenance, REST API Returns a **503** error code and following message is displayed in the response body:
`Scheduled maintenance in progress. Please try again later.`
Otherwise it will return 503 with a descriptive error message. Specific errors messages are listed with individual APIs. You can use **gdc/ping** resource to check the Platform availability.
## /gdc/ping
### GET
Checks Platform availability.
+ Request
+ Headers
Accept: application/json
+ Response 204
+ Response 503
+ Body
Scheduled maintenance in progress. Please try again later.
+ Response 503
+ Headers
Content-Type: application/json
+ Body
{"error":{
"message": "Internal server error. Please fill in bug report with request_id='{error-id}'"
}}
# Group Log In
<a id="login" ></a>
GoodData authentication uses two kinds of tokens to track user sessions:
- A long-lived **SST token**, which you obtain when you call `/gdc/account/login`
- A short-lived **TT token**, which you obtain when you call `gdc/account/token` using your **SST Token**. This token is encrypted, and is quickly verified by the resource servers.
**Steps:**
1. `POST` your credentials to the login resource. The SST token is returned in the SetCookie header.
2. `GET` the token resource, and include the SST token in your header. The TT token is returned in the SetCookie header.
You are now authenticated. Include this TT token in a -cookie header on all API calls.
>**Note:** The TT token has limited validity. If you received a 401 Unauthorized Response, GET a new TT token.
#### Additional Information
<!---You can use two methods to obtain and use tokens: _HTTP Cookies_ and _custom headers_. These methods are controlled by `verify_level` property upon login. The advantage of using Cookies (this is what the rich web client does) is that they work without additional non-standard extensions to the HTTP protocol: HTTP Cookies get issued for either of the tokens with appropriate path set. You don't need to specify verify_level if you intend to rely on cookie usage.
Unfortunately, this can not be used accross domains, and thus can not be used with data staging area. In case your client interfaces with the data uploads, you need set the verify_level property to value of 2. You'll get the token values in responses to login and token resources and you'll need to set the X-GDC-AuthSST and X-GDC-AuthTT headers to appropriate token values whenever they are required.
-->
## /gdc/account/login
### POST
Log in.
+ Parameters
+ login (required, string) ... GoodData login email address
+ password (required, string) ... GoodData password
+ remember (required, boolean) ... Specifies whether to remember login credentials.
+ verify_level (optional, integer, ``) ... Verification level of the token. Specify '0' for HTTP cookies; specify '2' for custom HTTP headers
+ Request (application/json)
+ Headers
Accept: application/json
+ Body
{
"postUserLogin":{
"login":"[email protected]",
"password":"YourPassword",
"remember":1
}
}
+ Response 200 (application/json)
+ Headers
Set-Cookie: GDCAuthTT=; path=/gdc; expires=Mon, 30-Jul-2012 09:12:42 GMT; secure; HttpOnly, GDCAuthSST={super-secured-token}; path=/gdc/account; secure; HttpOnly
+ Body
{
"userLogin":{
"profile":"/gdc/account/profile/{user-id}",
"state":"/gdc/account/login/{user-id}"
}
}
## /gdc/account/token
### GET
Request a TT token.
+ Request
+ Headers
Accept: application/json
Cookie: Set-Cookie: GDCAuthTT=; path=/gdc; expires=Mon, 30-Jul-2012 09:12:42 GMT; secure; HttpOnly, GDCAuthSST={super-secured-token}; path=/gdc/account; secure; HttpOnly
+ Response 200
+ Headers
Set-Cookie: set-cookie: GDCAuthTT={temporary-token}; path=/gdc; expires=Mon, 30-Jul-2012 09:12:42 GMT; secure; HttpOnly, GDCAuthSST={super-secured-token}; path=/gdc/account; secure; HttpOnly
## /gdc/account/profile/{user-id}
### GET
Retrieves details of your user account, including email addresses, phone number, and authentication provider. This information is also returned after successful authentication.
+ Request
+ Headers
Accept: application/json
+ Response 200
+ Body
{
"accountSetting" : {
"country" : "cz",
"firstName" : "Name",
"ssoProvider" : null,
"timezone" : null,
"position" : "",
"authenticationModes" : [],
"companyName" : "GoodData",
"login" : "[email protected]",
"email" : "[email protected]",
"created" : "2011-08-10 08:37:46",
"updated" : "2014-04-11 01:18:07",
"lastName" : "Lastname",
"phoneNumber" : "7755441225",
"links" : {
"self" : "/gdc/account/profile/{profile-id}",
"projects" : "/gdc/account/profile/{profile-id}/projects"
}
}
}
## /gdc/account/login/{user-id}
### DELETE
Log out.
+ Request
+ Headers
Accept: application/json
+ Response 200
# Group Objects
Objects are the entities in the GoodData Platform. For example, Dashboards, Reports, Metrics, and Data Permissions are objects.
## Object Creation [/gdc/md/{project-id}/obj{?createAndGet=true}]
### Create a New Object [POST]
Create a new object. The example below creates a new metric.
>**Note:** This example does not include the `createAndGet` parameter.
<!---
+ Parameters
+ title (required, string) ... Name of the new object
+ summary (optional, string) ... Object description
+ tags (optional, boolean) ... Tags to associate with the object. Separate tags with a space.
+ deprecated (optional, integer, ``) ... Verification level of the token. Specify '0' for HTTP cookies; specify '2' for custom HTTP headers
+ unlisted (boolean,
+ expression ( ) specifies the MAQL for the object.
+format (???, ??? ) Specifies the format that metrics are calculated in. Do not use
+folders (???, ???? ) The folder to include the object in.
-->
+ Request
+ Headers
Content-Type: application/json
Accept: application/json
+ Body
{
"metric": {
"meta": {
"title": "My new metric",
"summary": "",
"tags": "",
"deprecated": 0,
"unlisted": 1
},
"content": {
"expression": "SELECT SUM([/gdc/md/{project-id}/obj/{object-id}])",
"format": "#,##0.00",
"folders": []
}
}
}
+ Response 200
+ Headers
Content-Type: application/json
+ Body
{
"uri": "/gdc/md/{project-id}/obj/{object-id}"
}
### Create and Retrieve a New Object [POST]
Use this call to create new object. In this example you create a new metric and receive the complete object instead of link to it.
**With the createAndGet=true parameter.**
+ Request
+ Headers
Content-Type: application/json
Accept: application/json
+ Body
{
"metric": {
"meta": {
"title": "My new metric",
"summary": "",
"tags": "",
"deprecated": 0,
"unlisted": 1
},
"content": {
"expression": "SELECT SUM([/gdc/md/{project-id}/obj/{object-id}])",
"format": "#,##0.00",
"folders": []
}
}
}
+ Response 200
+ Headers
Content-Type: application/json
+ Body
{
"metric": {
"content": {
"format": "#,##0.00",
"tree": {
"content": [
{
"content": [
{
"value": "SUM",
"content": [
{
"value": "/gdc/md/{project-id}/obj/{object-id}",
"position": {
"column": 12,
"line": 2
},
"type": "fact object"
}
],
"position": {
"column": 8,
"line": 2
},
"type": "function"
}
],
"position": {
"column": 8,
"line": 2
},
"type": "expression"
}
],
"position": {
"column": 1,
"line": 2
},
"type": "metric"
},
"expression": "SELECT SUM([/gdc/md/{project-id}/obj/{object-id}])"
},
"meta": {
"author": "/gdc/account/profile/{user-id}",
"uri": "/gdc/md/{project-id}/obj/{object-id}",
"tags": "",
"created": "2014-07-07 10:02:54",
"identifier": "arFtGnK2gysS",
"deprecated": "0",
"summary": "",
"unlisted": 1,
"title": "My new metric",
"category": "metric",
"updated": "2014-07-07 10:02:54",
"contributor": "/gdc/account/profile/{user-id}"
}
}
}
## Existing Object Manipulation [/gdc/md/{project-id}/obj/{object-id}]
### Retrieve an Object [GET]
Use this call to retrieve an object from the API.
+ Request
+ Headers
Accept: application/json
+ Body
+ Response 200
+ Headers
Content-Type: application/json
+ Body
{
"metric": {
"content": {
"format": "#,##0.00",
"tree": {
"content": [
{
"content": [
{
"value": "SUM",
"content": [
{
"value": "/gdc/md/{project-id}/obj/{object-id}",
"position": {
"column": 12,
"line": 2
},
"type": "fact object"
}
],
"position": {
"column": 8,
"line": 2
},
"type": "function"
}
],
"position": {
"column": 8,
"line": 2
},
"type": "expression"
}
],
"position": {
"column": 1,
"line": 2
},
"type": "metric"
},
"expression": "SELECT SUM([/gdc/md/{project-id}/obj/{object-id}])"
},
"meta": {
"author": "/gdc/account/profile/{user-id}",
"uri": "/gdc/md/{project-id}/obj/{object-id}",
"tags": "",
"created": "2014-07-07 09:50:49",
"identifier": "adZtDDfkfAHG",
"deprecated": "0",
"summary": "",
"unlisted": 1,
"title": "My new metric",
"category": "metric",
"updated": "2014-07-07 09:50:49",
"contributor": "/gdc/account/profile/{user-id}"
}
}
}
### Update an Object [PUT]
Use this call to update existing object. Use the full object body/content with your changes. See the example where we've changed the Metric definition (`SUM` -> `AVG`)
+ Request
+ Headers
Content-Type: application/json
Accept: application/json
+ Body
{
"metric": {
"content": {
"format": "#,##0.00",
"tree": {
"content": [
{
"content": [
{
"value": "SUM",
"content": [
{
"value": "/gdc/md/{project-id}/obj/{object-id}",
"position": {
"column": 12,
"line": 2
},
"type": "fact object"
}
],
"position": {
"column": 8,
"line": 2
},
"type": "function"
}
],
"position": {
"column": 8,
"line": 2
},
"type": "expression"
}
],
"position": {
"column": 1,
"line": 2
},
"type": "metric"
},
"expression": "SELECT AVG([/gdc/md/{project-id}/obj/{object-id}])"
},
"meta": {
"author": "/gdc/account/profile/{user-id}",
"uri": "/gdc/md/{project-id}/obj/{object-id}",
"tags": "",
"created": "2014-07-07 09:50:49",
"identifier": "adZtDDfkfAHG",
"deprecated": "0",
"summary": "",
"unlisted": 1,
"title": "My new metric",
"category": "metric",
"updated": "2014-07-07 09:50:49",
"contributor": "/gdc/account/profile/{user-id}"
}
}
}
+ Response 200
+ Headers
Content-Type: application/json
+ Body
{
"uri": "/gdc/md/{project-id}/obj/{object-id}"
}
### Delete an Object [DELETE]
Use this resource to delete specific objects.
+ Request
+ Headers
Content-Type: application/json
Accept: application/json
+ Body
+ Response 204
+ Headers
+ Body
# Group Project
<a id="project" ></a>
Projects are one of the key objects in the GoodData platform. When working with GoodData, you basically create projects (datamarts). Metrics, Reports and Dashboards
are then created inside Projects. The following two states are key for you and your integrations:
- **ENABLED** - project is ready and available
- **DELETED** - something is wrong
Once you create a Project with a `POST` request shown below, [poll the returned url](#get-%2Fgdc%2Fprojects%2F%7Bproject-id%7D) and check the Project `state` value until it is **ENABLED** or **DELETED**. Find out more information about how to create a [project programatically on this discussion thread](http://stackoverflow.com/questions/22647479/gooddata-how-to-create-a-project-through-api). Other states that project can be in:
- PREPARING
- LOADING
- PREPARED
- DISABLED
- ARCHIVED
###Project Properties
- title (string) : Project Title
- summary (string) : Project summary
- roles (uri) : User's role in the Project
- userPermissions (uri) : User permissions information
- userRoles (uri) : User roles information
- users (uri) : Project users information
- created (date) : Date of project creation
- updated (date) : Date of project update
- author (uri) : Project creator account
- exportUsers (boolean) : export users from project true/false
- exportData (boolean) : export data from project true/false
- token (string) : export Token for export/import project usage
## /gdc/projects
### POST
To create new project, use following call. Poll the resource that you received as response until it gives you the status: **ENABLED** or **DELETED**
See the next API call for more details.
+ Request (application/json)
+ Headers
Accept: application/json
+ Body
{ "project" : {
"content" : { "guidedNavigation": 1, "driver" : "Pg", "authorizationToken" : "AUTH_TOKEN"},
"meta" : {
"title" : "Test Project",
"summary" : "Testing Project",
"projectTemplate" : "/projectTemplates/{template-name}/{template-version}"
} }
}
+ Response 201 (application/json)
{
"uri" : "/gdc/projects/{project-id}"
}
## /gdc/projects/{project-id}
### GET
To show the Project information after creation or whenever you need it. While creating a new project, poll this resource until the `state` is **ENABLED** or **DELETED**.
+ Request
+ Headers
Accept: application/json
+ Response 200 (application/json)
{
"project" : {
"content" : {
"guidedNavigation" : "1",
"isPublic" : "0",
"state" : "ENABLED"
},
"links" : {
"roles" : "/gdc/projects/{project-id}/roles",
"ldm_thumbnail" : "/gdc/projects/{project-id}/ldm?thumbnail=1",
"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",
"publicartifacts" : "/gdc/projects/{project-id}/publicartifacts",
"metadata" : "/gdc/md/{project-id}",
"templates" : "/gdc/md/{project-id}/templates"
},
"meta" : {
"created" : "2012-05-01 23:56:01",
"summary" : "Project Summary",
"updated" : "2012-05-01 23:56:01",
"author" : "/gdc/account/profile/{user-id}",
"title" : "Project Name",
"contributor" : "/gdc/account/profile/{user-id}"
}
}
}
### DELETE
This API call will DELETE your defined project. Only Project ADMIN can do this action.
+ Request
+ Headers
Accept: application/json
+ Response 200 (application/json)
{}
## /gdc/account/profile/{user-id}/projects
### GET
To list all existing projects
+ Request
+ Headers
Accept: application/json
+ Response 200 (application/json)
{
"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/{user-id}/permissions",
"userRoles" : "/gdc/projects/{project-id}/users/{user-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/{project-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/{user-id}",
"title" : "Project Name",
"contributor" : "/gdc/account/profile/{user-id}"
}
}
} ]
}
## /gdc/md/{project-id}/maintenance/export
### POST
To Export selected Project - exportUsers and exportData field are not mandatory. You receive Export token that is valid for **48 hours**.
+ Request (application/json)
+ Headers
Accept: application/json
+ Body
{ "exportProject" : {
"exportUsers" : "1 | 0",
"exportData" : "1 | 0"
}
}
+ Response 200 (application/json)
{
"exportArtifact" : {
"status" : {
"uri" : "/gdc/md/{project-id}/etltask/{task-id}"
},
"token" : "EXPORT_TOKEN"
}
}
## /gdc/md/{project-id}/maintenance/import
### POST
Use this method to import exported Project. Input is the Token exported from previous Export resource. You have to finish export/import during 48 hours (then - the token is no more valid)
+ Request (application/json)
+ Headers
Accept: application/json
+ Body
{
"importProject" : {
"token" : "TOKEN_STRING"
}
}
+ Response 200 (application/json)
{
"uri" : "/gdc/md/{project-id}/etltask/{task-id}"
}
## /gdc/projects/{project-id}/styleSettings
### PUT
To create your own custom colour palette in given Project
+ Request (application/json)
+ Headers
Accept: application/json
+ Body
{"styleSettings" :
{"chartPalette": [
{ "guid": "guid1", "fill": { "r":255, "g":255, "b":0 } },
{ "guid": "guid2", "fill": { "r":255, "g":255, "b":40 } },
{ "guid": "guid3", "fill": { "r":255, "g":255, "b":80 } },
{ "guid": "guid4", "fill": { "r":255, "g":255, "b":120 } },
{ "guid": "guid5", "fill": { "r":255, "g":255, "b":180 } },
{ "guid": "guid6", "fill": { "r":255, "g":255, "b":200 } }
]
}
}
+ Response 204
### GET
To GET your current color palette
+ Request
+ Headers
Accept: application/json
+ Response 200 (application/json)
{"styleSettings" :
{"chartPalette": [
{ "guid": "guid1", "fill": { "r":255, "g":255, "b":0 } },
{ "guid": "guid2", "fill": { "r":255, "g":255, "b":40 } },
{ "guid": "guid3", "fill": { "r":255, "g":255, "b":80 } },
{ "guid": "guid4", "fill": { "r":255, "g":255, "b":120 } },
{ "guid": "guid5", "fill": { "r":255, "g":255, "b":180 } },
{ "guid": "guid6", "fill": { "r":255, "g":255, "b":200 } }
]
}
}
### DELETE
To Delete/Reset your own custom colour palette in given Project
+ Request
+ Headers
Accept: application/json
+ Response 204
## /gdc/projects/{project-id}/roles
### GET
To GET User roles for given project. Use following API call. There are 6 default roles (id 1-5), but these IDs are not fixed for specific user roles. You have to GET role details (following API call below) to set User roles correctly.
+ Request
+ Headers
Accept: application/json
+ Response 200 (application/json)
{
"projectRoles": {
"roles": [
"/gdc/projects/{project-id}/roles/{role-id}",
"/gdc/projects/{project-id}/roles/{role-id}"
],
"links": {
"project": "/gdc/projects/{project-id}/"
}
}
}
## /gdc/projects/{project-id}/roles/{role-id}
### GET
To GET details about specific project role, use this API call.
+ Request
+ Headers
Accept: application/json
+ Response 200
{
"projectRole": {
"permissions": {
"canAccessIntegration": "0",
"canCreateProjectDashboard": "0",
"canManageComment": "0",
"canCreateDimensionMapping": "0",
"canInitData": "0",
"canManageIntegration": "0",
"canManageFolder": "0",
"canInviteUserToProject": "0",
"canCreateDomain": "0",
"canCreateTableDataLoad": "0",
"canSeeOtherUserDetails": "0",
"canCreateETLInterface": "0",
"canCreateRole": "0",
"canCreateReportResult": "1",
"canCreateHelp": "0",
"canManageDomain": "0",
"canManageAttributeLabel": "0",
"canCreateColumn": "0",
"canManageReport": "0",
"canManageDataSet": "0",
"canSetUserVariables": "0",
"canCreateAttributeGroup": "0",
"canValidateProject": "0",
"canMaintainProject": "0",
"canCreateETLFile": "0",
"canCreateScheduledMail": "0",
"canManageETLSession": "0",
"canSuspendUserFromProject": "0",
"canMaintainUserFilterRelation": "0",
"canManageAttribute": "0",
"canManageReportDefinition": "0",
"canCreateReportResult2": "1",
"canMaintainUserFilter": "0",
"canCreateReport": "0",
"canManageETLFile": "0",
"canCreateComment": "0",
"canCreateDataSet": "0",
"canCreateTable": "0",
"canManageTableDataLoad": "0",
"canManageDimensionMapping": "0",
"canCreateMetric": "0",
"canRefreshData": "0",
"canManageProjectDashboard": "0",
"canManageProject": "0",
"canManagePrompt": "0",
"canManageETLInterface": "0",
"canManageReportResult2": "0",
"canAccessWorkbench": "0",
"canCreateAttributeLabel": "0",
"canManageColumn": "0",
"canCreatePrompt": "0",
"canManagePublicAccessCode": "0",
"canListUsersInProject": "0",
"canManageAttributeGroup": "0",
"canManageMetric": "0",
"canManageHelp": "0",
"canManageTable": "0",
"canSetProjectVariables": "0",
"canCreateETLSession": "0",
"canCreateFolder": "0",
"canManageFact": "0",
"canListInvitationsInProject": "0",
"canManageScheduledMail": "0",
"canManageReportResult": "1",
"canManageAnnotation": "0",
"canSeePublicAccessCode": "0",
"canCreateReportDefinition": "1",
"canCreateFact": "0",
"canCreateAttribute": "0",
"canAssignUserWithRole": "0",
"canCreateAnnotation": "0"
},
"links": {
"roleUsers": "/gdc/projects/{project-id}/roles/{role-id}/users"
},
"meta": {
"created": "2012-07-25 11:28:52",
"identifier": "dashboardOnlyRole",
"summary": "dashboard only",
"author": "/gdc/account/profile/{user-id}",
"updated": "2012-07-25 11:28:52",
"title": "Embedded Dashboard Only",
"contributor": "/gdc/account/profile/{user-id}"
}
}
}
## /gdc/md/{project-id}/service/timezone
### POST
To change the Project timezone. Find more information [in the article](https://developer.gooddata.com/article/setting-a-custom-time-zone-for-your-project). Use [Olson DB timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) identifiers.
+ Request (application/json)
+ Headers
Accept: application/json
+ Body
{
"service": {
"timezone": "UTC"
}
}
+ Response 200
+ Headers
Content-Type: application/json
+ Body
{
"service": {
"timezone": "UTC"
}
}
# Group User
<a id="user" ></a>
To manage users via the User Provisioning API Resources, you need to have your own domain. If you have it, you can simply use the requests below.
###User Properties
- login (string) : User login
- password (string) : User password
- verifyPassword (string) : Password for verification
- email : User's email for invitations, used as contact email
- firstname (string) : User's firstname
- lastname (string) : User's lastname
- userRoles (uri) : Uri to the specific user roles
- projectUsersUpdateResult : Give an array of successful/failed created users
- companyName (string) : Name of user's company
- country (string) : User's country
- created (date) : Date of user creation
- updated (date) : Date of user properties update
- phoneNumber : User's phonenumber
- position (string) : User's position in a company
- authenticationModes (array of strings) : an optional field specifying authentication modes (SSO, PASSWORD) allowed for this user. The value of this field overrides the global settings for the domain.
## /gdc/account/domains/{organization-name}/users
### POST
To create new user in your domain - use this resource. The API will give you new user's uri. You have to be ORGANIZATION admin for provision the user to the Project.
+ Request
+ Headers
Accept: application/json
+ Body
{
"accountSetting":{
"login": "[email protected]",
"password":"PASSWORD",
"email":"[email protected]",
"verifyPassword":" PASSWORD ",
"firstName":"FirstName",
"lastName":"LastName",
"ssoProvider":"SSO-PROVIDER"
}
}
+ Response 200
{
"uri" : "/gdc/account/profile/{profile-id}"
}