Produced by Araxis Merge on 7/13/2017 3:41:46 PM Eastern Daylight Time. See www.araxis.com for information about Merge. This report uses XHTML and CSS2, and is best viewed with a modern standards-compliant browser. For optimum results when printing this report, use landscape orientation and enable printing of background images and colours in your browser.
| # | Location | File | Last Modified |
|---|---|---|---|
| 1 | Genisis_v3.zip\Release 3_Docs | Genisis2_VIP_Release 3_API_06162017.docx | Tue Jul 11 16:54:34 2017 UTC |
| 2 | Genisis_v3.zip\Release 3_Docs | Genisis2_VIP_Release 3_API_06162017.docx | Thu Jul 13 12:41:52 2017 UTC |
| Description | Between Files 1 and 2 |
|
|---|---|---|
| Text Blocks | Lines | |
| Unchanged | 1 | 4428 |
| Changed | 0 | 0 |
| Inserted | 0 | 0 |
| Removed | 0 | 0 |
| Whitespace | |
|---|---|
| Character case | Differences in character case are significant |
| Line endings | Differences in line endings (CR and LF characters) are ignored |
| CR/LF characters | Not shown in the comparison detail |
No regular expressions were active.
| 1 | Genomic In formation System for Integrate d Science 2 (Genisis 2) APls | |
| 2 | The API fo r Genisis2 uses REST fulcalls t o perform create, re trieve, up date and d elete {CRU D) operati ons on the back-end services f or the Gen isis2 appl ication. T his docume nt contain s an overv iew of the standard convention s used in the API, a s well as a detailed overview of each AP I endpoint and a sam ple calls and respon ses. | |
| 3 | ||
| 4 | ||
| 5 | commentHis tory : com mentHistor y API | |
| 6 | Bl /servic es/comment Creates th e comment history | |
| 7 | ||
| 8 | Implementa tion Notes | |
| 9 | This will create a n ew study a pproval | |
| 10 | ||
| 11 | Response C lass (Stat us 200) Su ccess | |
| 12 | Model Ex ample Valu e | |
| 13 | ||
| 14 | ||
| 15 | I{ | |
| 16 | "commentld ": 0, "com ments": "s tring", "c reatedBy": "string", | |
| 17 | "createdOn ": "2017-0 6-12Tl4:45 :08.352Z", | |
| 18 | "request": { "approv erid": "st ring", "co mments": " string", " createdBy" :"string", | |
| 19 | "createdOn " :"2017-0 6-12T14:45 :08.352Z", | |
| 20 | ||
| 21 | ||
| 22 | ||
| 23 | ||
| 24 | Response C ontent Typ e | |
| 25 | cation/jso n .,. I | |
| 26 | Parameters | |
| 27 | ||
| 28 | Parameter | |
| 29 | Value | |
| 30 | Descriptio n | |
| 31 | Parameter Data Type Type | |
| 32 | ||
| 33 | ||
| 34 | (required) commentHis tory | |
| 35 | CommentHis tory body details | |
| 36 | Model Exa mple Value | |
| 37 | ||
| 38 | { | |
| 39 | ||
| 40 | ||
| 41 | ||
| 42 | ||
| 43 | ||
| 44 | ||
| 45 | Parameter content ty pe: [aPPli cation/jso ilY] | |
| 46 | "commentid ": 0, "com ments":Rst ringft , " createdBy" : "string" , | |
| 47 | "createdOn ": "2017-0 6-12T14:45 :08.402Z", | |
| 48 | "request": { "approv erid": "st ring", "co mments": " string", " createdByf t: "string ", | |
| 49 | "createdon ft: "2017- 06-12T14:4 5:08.402Z" , | |
| 50 | "descripti on": "stri ng", | |
| 51 | : e. | |
| 52 | ||
| 53 | 11 id 11 | |
| 54 | ||
| 55 | Response M essages | |
| 56 | ||
| 57 | ||
| 58 | HTTP Statu sCodeReaso nResponse ModelHeade rs | |
| 59 | ||
| 60 | ||
| 61 | 201Created | |
| 62 | ||
| 63 | 401Unautho rized | |
| 64 | ||
| 65 | 403Forbidd en | |
| 66 | ||
| 67 | 404Not Fou nd | |
| 68 | ||
| 69 | ||
| 70 | Try it out ! | |
| 71 | ||
| 72 | ||
| 73 | ||
| 74 | ||
| 75 | ||
| 76 | requests : requests API | |
| 77 | ||
| 78 | ||
| 79 | /services/ copytable/ domainsCop y table Do mains | |
| 80 | ||
| 81 | Implementa tion Notes | |
| 82 | This call will get c opy table domain fro m VINCI | |
| 83 | ||
| 84 | Response C lass (Stat us 200) | |
| 85 | Success | |
| 86 | ||
| 87 | ||
| 88 | ModelExamp le Value | |
| 89 | ||
| 90 | { | |
| 91 | "dUsername ": "string ", "destin ationDBNam e": "strin g", "desti nationDBSe rverName": "string" , "sUserna me": "stri ng", "sour ceDBName": "string", "sourceDB ServerName ": "strin g" | |
| 92 | } | |
| 93 | ||
| 94 | ||
| 95 | ||
| 96 | ||
| 97 | Response C ontent Typ e I applic ation/json T I | |
| 98 | ||
| 99 | Response M essages | |
| 100 | HTTP Statu s | |
| 101 | CodeReason Response M odelHeader s | |
| 102 | ||
| 103 | ||
| 104 | 401Unautho rized | |
| 105 | ||
| 106 | 403Forbidd en | |
| 107 | ||
| 108 | 404Not Fou nd | |
| 109 | ||
| 110 | ||
| 111 | Try it out ! | |
| 112 | ||
| 113 | ||
| 114 | ||
| 115 | ||
| 116 | ||
| 117 | ||
| 118 | /services/ datasource sGets the request da ta sources | |
| 119 | ||
| 120 | ||
| 121 | ||
| 122 | Implementa tion Notes | |
| 123 | Retrives l ist of Sou rces from a GenisisD B | |
| 124 | ||
| 125 | Response C lass (Stat us 200) | |
| 126 | Success | |
| 127 | ||
| 128 | ||
| 129 | ModelExamp le Value | |
| 130 | ||
| 131 | {I | |
| 132 | "descripti on": "stri ng", "id": 0, | |
| 133 | "requests" : [ | |
| 134 | { | |
| 135 | "approveri d ": "stri ng", "comm ents" : "s tring", "c reatedBy " : "string" , | |
| 136 | "createdOn ": "2017- 06-12T14:4 5:08.458Z" , | |
| 137 | ||
| 138 | ||
| 139 | ||
| 140 | Response C ontent Typ e I applic ation/json I | |
| 141 | ||
| 142 | Response M essages | |
| 143 | ||
| 144 | HTTP Statu sCodeReaso nResponse ModelHeade rs | |
| 145 | ||
| 146 | ||
| 147 | 401Unautho rized | |
| 148 | ||
| 149 | 403Forbidd en | |
| 150 | ||
| 151 | 404Not Fou nd | |
| 152 | ||
| 153 | ||
| 154 | Try it out ! | |
| 155 | ||
| 156 | ||
| 157 | ||
| 158 | ||
| 159 | ||
| 160 | ||
| 161 | ||
| 162 | /services/ requestTyp esGets the request t ypes | |
| 163 | ||
| 164 | Implementa tion Notes | |
| 165 | Retrives l ist of req uest types from a Ge nisisDB | |
| 166 | ||
| 167 | Response C lass (Stat us 200) | |
| 168 | Success | |
| 169 | ||
| 170 | ||
| 171 | ModelExamp le Value | |
| 172 | ||
| 173 | {I | |
| 174 | ||
| 175 | "descripti on": "id": 0, | |
| 176 | "requests" : [ | |
| 177 | { | |
| 178 | "string", | |
| 179 | ||
| 180 | "approveri d": "strin g", | |
| 181 | ||
| 182 | "comments" : "string" , "created By": "stri ng", | |
| 183 | "createdOn ": "2017- 06-12T14:4 5:08.474Z" , | |
| 184 | ||
| 185 | ||
| 186 | Response C ontent Typ e I applic ation/json I | |
| 187 | ||
| 188 | Response M essages | |
| 189 | HTTP Statu s | |
| 190 | CodeReason Response M odelHeader s | |
| 191 | ||
| 192 | ||
| 193 | 401Unautho rized | |
| 194 | ||
| 195 | 403Forbidd en | |
| 196 | ||
| 197 | 404Not Fou nd | |
| 198 | ||
| 199 | ||
| 200 | Try it out ! | |
| 201 | ||
| 202 | ||
| 203 | ||
| 204 | ||
| 205 | ||
| 206 | ||
| 207 | ||
| 208 | /services/ requestsGe ts the all requests | |
| 209 | ||
| 210 | Implementa tion Notes | |
| 211 | Returns a list of al l requests in the Ge nisis2 | |
| 212 | ||
| 213 | Response C lass (Stat us 200) | |
| 214 | Success | |
| 215 | ||
| 216 | ||
| 217 | ModelExamp le Value | |
| 218 | ||
| 219 | ||
| 220 | {"approver id" : "str ing",I | |
| 221 | "comments" : "string" , "created By": "stri ng", | |
| 222 | "createdOn ": "2017-0 6-12T14:45 :08.493Z", | |
| 223 | "descripti on": "stri ng", "id": 0, | |
| 224 | "modifiedB y": "strin g", | |
| 225 | "modifiedO n": "2017- 06-12T14:4 5:08.493Z" , | |
| 226 | "requestHi stories" : | |
| 227 | I | |
| 228 | ||
| 229 | Response C ontent Typ e I applic ation/json I | |
| 230 | ||
| 231 | Response M essages | |
| 232 | ||
| 233 | HTTP Statu sCodeReaso nResponse ModelHeade rs | |
| 234 | ||
| 235 | ||
| 236 | 401Unautho rized | |
| 237 | ||
| 238 | 403Forbidd en | |
| 239 | ||
| 240 | 404Not Fou nd | |
| 241 | ||
| 242 | ||
| 243 | Try it out ! | |
| 244 | ||
| 245 | ||
| 246 | ||
| 247 | ||
| 248 | - /service s/requests | |
| 249 | ||
| 250 | Implementa tion Notes | |
| 251 | ||
| 252 | ||
| 253 | Creates th e request | |
| 254 | This call will creat e a new re quest | |
| 255 | ||
| 256 | ||
| 257 | ||
| 258 | Response C lass (Stat us 200) | |
| 259 | ||
| 260 | ||
| 261 | ||
| 262 | string | |
| 263 | ||
| 264 | ||
| 265 | ||
| 266 | Response C ontent Typ e I applic ation/json T I | |
| 267 | ||
| 268 | ||
| 269 | ||
| 270 | Parameters | |
| 271 | ||
| 272 | ||
| 273 | ||
| 274 | ParameterV alueDescri ption | |
| 275 | Parameter Type | |
| 276 | Data Type | |
| 277 | ||
| 278 | ||
| 279 | request | |
| 280 | ||
| 281 | ||
| 282 | (required) | |
| 283 | ||
| 284 | Parameter content ty pe: | |
| 285 | I applicat ion/json T I | |
| 286 | request de tails | |
| 287 | body | |
| 288 | Example Va lue | |
| 289 | ||
| 290 | ||
| 291 | Model | |
| 292 | I{ | |
| 293 | "approveri d ": "stri ng", "comm ents" : "s tring", "c reatedBy " : "string" , | |
| 294 | "createdOn ": "2017-0 6-12T14:45 :08.518Z", | |
| 295 | "descripti on": "stri ng", "id": 0, | |
| 296 | "modifiedB y": "strin g", | |
| 297 | "modifiedO n ": "2017 -06-12T14: 45:08.518Z ", | |
| 298 | "requestHi stories": [ | |
| 299 | { | |
| 300 | ||
| 301 | "aoorover d": "strin e" . | |
| 302 | ||
| 303 | ||
| 304 | Response M essages | |
| 305 | ||
| 306 | CodeHTTP S tatusReaso n | |
| 307 | ||
| 308 | ||
| 309 | Response M odelHeader s | |
| 310 | ||
| 311 | ||
| 312 | 201Created | |
| 313 | ||
| 314 | 401Unautho rized | |
| 315 | ||
| 316 | 403Forbidd en | |
| 317 | ||
| 318 | 404Not Fou nd | |
| 319 | ||
| 320 | ||
| 321 | Try it out ! | |
| 322 | ||
| 323 | ||
| 324 | ||
| 325 | ||
| 326 | ||
| 327 | /services/ requests/{ id}Gets th e requests by id | |
| 328 | ||
| 329 | Implementa tion Notes | |
| 330 | Return a r equest giv en the req uest ID | |
| 331 | ||
| 332 | Response C lass (Stat us 200) | |
| 333 | Success | |
| 334 | ||
| 335 | ||
| 336 | ModelExamp le Value | |
| 337 | ||
| 338 | ||
| 339 | I{ | |
| 340 | "approverl d": "strin g", "comme nts": "str ing", "cre atedBy": " string", | |
| 341 | "createdOn ": "2017-0 6-12T14:45 :08.533Z", | |
| 342 | "descripti on" : "str ing", | |
| 343 | "id11 : 0 , | |
| 344 | "modifiedB y": "strin g", | |
| 345 | "modifiedO n": "2017- 06-12T14:4 5:08.533Z" , | |
| 346 | "requestHi stories ": | |
| 347 | I | |
| 348 | ||
| 349 | Response C ontent Typ e I applic ation/json " I | |
| 350 | ||
| 351 | ||
| 352 | Parameters | |
| 353 | ||
| 354 | TypeParame terValueDe scriptionP arameter | |
| 355 | ||
| 356 | ||
| 357 | Data Type | |
| 358 | ||
| 359 | ||
| 360 | ||
| 361 | ||
| 362 | ||
| 363 | l<required )idRequest IDpath | |
| 364 | integer | |
| 365 | ||
| 366 | ||
| 367 | ||
| 368 | ||
| 369 | Response M essages | |
| 370 | ||
| 371 | HTTP Statu sCodeReaso nResponse Model | |
| 372 | 401Unautho rized | |
| 373 | ||
| 374 | ||
| 375 | ||
| 376 | Headers | |
| 377 | ||
| 378 | ||
| 379 | 403Forbidd en | |
| 380 | ||
| 381 | 404Not Fou nd | |
| 382 | ||
| 383 | ||
| 384 | Try it out ! | |
| 385 | ||
| 386 | ||
| 387 | ||
| 388 | ||
| 389 | ||
| 390 | ||
| 391 | ||
| 392 | -/services /requests/ {i d} | |
| 393 | ||
| 394 | Implementa tion Notes | |
| 395 | Modify and save chan ges to a r equest det ails | |
| 396 | ||
| 397 | ||
| 398 | Response C lass (Stat us 200) | |
| 399 | int32 | |
| 400 | ||
| 401 | ||
| 402 | Response C ontent Typ e I applic ation/json " I | |
| 403 | Parameters | |
| 404 | ||
| 405 | TypeParame terValueDe scriptionP arameter | |
| 406 | ||
| 407 | ||
| 408 | ||
| 409 | ||
| 410 | ||
| 411 | ||
| 412 | ||
| 413 | ||
| 414 | ||
| 415 | ||
| 416 | ||
| 417 | ||
| 418 | ||
| 419 | ||
| 420 | ||
| 421 | ||
| 422 | ||
| 423 | Data Type | |
| 424 | Update req uest detai ls | |
| 425 | ||
| 426 | ||
| 427 | ||
| 428 | ||
| 429 | !<required )idRequest lDpathinte ger | |
| 430 | ||
| 431 | ||
| 432 | TypeParame terValueDe scriptionP arameter | |
| 433 | Data Type | |
| 434 | ||
| 435 | ||
| 436 | ||
| 437 | ||
| 438 | request | |
| 439 | ||
| 440 | ||
| 441 | (required) | |
| 442 | ||
| 443 | Parameter content ty pe: | |
| 444 | I applicat ion/json • I | |
| 445 | request de tails | |
| 446 | body | |
| 447 | Example Va lue | |
| 448 | ||
| 449 | ||
| 450 | Model | |
| 451 | I{ | |
| 452 | "approveri d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 453 | "createdOn ": "2017-0 6-12T14:45 :08.567Z", | |
| 454 | "descripti on": "stri ng", | |
| 455 | 11 id": 0 , | |
| 456 | "modifiedB y ": "stri ng", | |
| 457 | "modifiedO n ": "2017 -06-12T14: 45:08.567Z ", | |
| 458 | "requestHi stories" : [ | |
| 459 | { | |
| 460 | ||
| 461 | "aoorover d": "strin 2". | |
| 462 | ||
| 463 | ||
| 464 | Response M essages | |
| 465 | ||
| 466 | CodeHTTP S tatusReaso n | |
| 467 | ||
| 468 | ||
| 469 | Response M odel | |
| 470 | ||
| 471 | ||
| 472 | Headers | |
| 473 | ||
| 474 | ||
| 475 | 201Created | |
| 476 | ||
| 477 | ||
| 478 | 401Unautho rized | |
| 479 | ||
| 480 | 403Forbidd en | |
| 481 | ||
| 482 | 404Not Fou nd | |
| 483 | ||
| 484 | ||
| 485 | Try it out ! | |
| 486 | ||
| 487 | ||
| 488 | ||
| 489 | ||
| 490 | ||
| 491 | ||
| 492 | /services/ requests/{ id}/accept data | |
| 493 | ||
| 494 | Implementa tion Notes | |
| 495 | Modify and save chan ges to a r equest det ails | |
| 496 | ||
| 497 | Response C lass (Stat us 200) | |
| 498 | int32 | |
| 499 | ||
| 500 | Response C ontent Typ e I applic ation/json • I | |
| 501 | ||
| 502 | Parameters | |
| 503 | ||
| 504 | Fulfill re quest | |
| 505 | ||
| 506 | ||
| 507 | Parameter | |
| 508 | Value | |
| 509 | Descriptio n | |
| 510 | Parameter Type | |
| 511 | Data Type | |
| 512 | id | |
| 513 | !(required ) | |
| 514 | RequestlD | |
| 515 | path | |
| 516 | integer | |
| 517 | ||
| 518 | ||
| 519 | TypeParame terValueDe scriptionP arameter | |
| 520 | Data Type | |
| 521 | ||
| 522 | ||
| 523 | ||
| 524 | ||
| 525 | request | |
| 526 | ||
| 527 | ||
| 528 | (required) | |
| 529 | ||
| 530 | Parameter content ty pe: | |
| 531 | I applicat ion/json • I | |
| 532 | request de tails | |
| 533 | body | |
| 534 | Example Va lue | |
| 535 | ||
| 536 | ||
| 537 | Model | |
| 538 | I{ | |
| 539 | "approveri d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 540 | "createdOn ": "2017-0 6-12T14:45 :08.590Z", | |
| 541 | "descripti on": "stri ng", | |
| 542 | 11 id": 0 , | |
| 543 | "modifiedB y ": "stri ng", | |
| 544 | "modifiedO n" : "2017 -06-12T14: 45:08.590Z ", | |
| 545 | "requestHi stories" : [ | |
| 546 | { | |
| 547 | ||
| 548 | "aoorover d": "strin 2". | |
| 549 | ||
| 550 | ||
| 551 | Response M essages | |
| 552 | ||
| 553 | CodeHTTP S tatusReaso n | |
| 554 | ||
| 555 | ||
| 556 | Response M odel | |
| 557 | ||
| 558 | ||
| 559 | Headers | |
| 560 | ||
| 561 | ||
| 562 | 201Created | |
| 563 | ||
| 564 | ||
| 565 | 401Unautho rized | |
| 566 | ||
| 567 | 403Forbidd en | |
| 568 | ||
| 569 | 404Not Fou nd | |
| 570 | ||
| 571 | ||
| 572 | Try it out ! | |
| 573 | ||
| 574 | ||
| 575 | ||
| 576 | ||
| 577 | ||
| 578 | ||
| 579 | /services/ requests/{ id}/confir mdata | |
| 580 | ||
| 581 | Implementa tion Notes | |
| 582 | Modify and save chan ges to a r equest det ails | |
| 583 | ||
| 584 | Response C lass (Stat us 200) | |
| 585 | int32 | |
| 586 | ||
| 587 | Response C ontent Typ e I applic ation/json • I | |
| 588 | ||
| 589 | Parameters | |
| 590 | ||
| 591 | Aceept req uest | |
| 592 | ||
| 593 | ||
| 594 | Parameter | |
| 595 | Value | |
| 596 | Descriptio n | |
| 597 | Parameter Type | |
| 598 | Data Type | |
| 599 | id | |
| 600 | !(required ) | |
| 601 | RequestlD | |
| 602 | path | |
| 603 | integer | |
| 604 | ||
| 605 | ParameterV alueDescri ptionParam eter Type | |
| 606 | Data Type | |
| 607 | ||
| 608 | request | |
| 609 | ||
| 610 | ||
| 611 | (required) | |
| 612 | ||
| 613 | Parameter content ty pe: | |
| 614 | I applicat ion/json • I | |
| 615 | request de tails | |
| 616 | ||
| 617 | body | |
| 618 | ||
| 619 | ||
| 620 | ModelExamp le Value | |
| 621 | ||
| 622 | ||
| 623 | I{ | |
| 624 | "approveri d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 625 | "createdOn ": "2017-0 6-12T14:45 :08.608Z", | |
| 626 | "descripti on": "stri ng", | |
| 627 | 11 id": 0 , | |
| 628 | "modifiedB y ": "stri ng", | |
| 629 | "modifiedO n" : "2017 -06-12T14: 45:08.608Z ", | |
| 630 | "requestHi stories" : [ | |
| 631 | { | |
| 632 | ||
| 633 | "aoorover d": "strin 2". | |
| 634 | ||
| 635 | ||
| 636 | Response M essages | |
| 637 | ||
| 638 | CodeHTTP S tatusReaso n | |
| 639 | ||
| 640 | 201Created | |
| 641 | ||
| 642 | 401Unautho rized | |
| 643 | ||
| 644 | 403Forbidd en | |
| 645 | ||
| 646 | 404Not Fou nd | |
| 647 | ||
| 648 | ||
| 649 | Try it out ! | |
| 650 | ||
| 651 | ||
| 652 | Response M odelHeader s | |
| 653 | ||
| 654 | ||
| 655 | ||
| 656 | ||
| 657 | ||
| 658 | ||
| 659 | /services/ requests/{ id}/dataMa nagerGets the reques t by data manager | |
| 660 | ||
| 661 | Implementa tion Notes | |
| 662 | Returns a list of al l requests created b y or submi tted to th e data man ager | |
| 663 | ||
| 664 | Response C lass (Stat us 200) | |
| 665 | Success | |
| 666 | ||
| 667 | ||
| 668 | ||
| 669 | ModelExamp le Value | |
| 670 | ||
| 671 | { | |
| 672 | "approverl d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 673 | "createdOn ": "2017-0 6-12T14:45 :08.619Z", | |
| 674 | "descripti on": "stri ng", "id": 0, | |
| 675 | "modifiedB y": "strin g", | |
| 676 | "modifiedO n": "2017- 06-12T14:4 5:08.619Z" , | |
| 677 | "requestHi stories ": | |
| 678 | I | |
| 679 | .. | |
| 680 | I | |
| 681 | ||
| 682 | ||
| 683 | ||
| 684 | .... | |
| 685 | ||
| 686 | Response Content T ype I appl ication/js on T I | |
| 687 | ||
| 688 | ||
| 689 | Parameters | |
| 690 | ||
| 691 | TypeParame terValueDe scriptionP arameter | |
| 692 | ||
| 693 | ||
| 694 | Data Type | |
| 695 | ||
| 696 | ||
| 697 | ||
| 698 | ||
| 699 | !<required )idUser's IDpathstr ing | |
| 700 | ||
| 701 | ||
| 702 | Response M essages | |
| 703 | ||
| 704 | HTTP Statu sCodeReaso nResponse ModelHeade rs | |
| 705 | ||
| 706 | ||
| 707 | 401Unautho rized | |
| 708 | ||
| 709 | ||
| 710 | 1¥ttP Stat us Code | |
| 711 | Forbidden | |
| 712 | ReasonResp onse Model Headers | |
| 713 | ||
| 714 | -40<t-t:.. ..t-- | |
| 715 | ||
| 716 | ||
| 717 | Try it out ! | |
| 718 | ||
| 719 | ||
| 720 | ||
| 721 | ||
| 722 | ||
| 723 | ||
| 724 | ||
| 725 | /services/ requests/{ id}/dataSo urceManage rGets the request by data sour ce manager | |
| 726 | ||
| 727 | Implementa tion Notes | |
| 728 | Returns a list of al l requests accepted or not-acc epcted by all data s ource mana gers | |
| 729 | ||
| 730 | ||
| 731 | Response C lass (Stat us 200) | |
| 732 | Success | |
| 733 | ||
| 734 | ||
| 735 | ModelExamp le Value | |
| 736 | ||
| 737 | ||
| 738 | ||
| 739 | I{ | |
| 740 | "approveri d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 741 | "createdOn ": "2017-0 6-12T14:45 :08.635Z", | |
| 742 | "descripti on ": "str ing", "id" : 0, | |
| 743 | "modifiedB y ": "stri ng", | |
| 744 | "modifiedO n ": "2017 -06-12T14: 45:08.635Z ", | |
| 745 | ||
| 746 | ||
| 747 | ||
| 748 | Response Content T ype I appl ication/js on T I | |
| 749 | ||
| 750 | ||
| 751 | Parameters | |
| 752 | ||
| 753 | TypeParame terValueDe scriptionP arameter | |
| 754 | ||
| 755 | ||
| 756 | Data Type | |
| 757 | ||
| 758 | ||
| 759 | ||
| 760 | ||
| 761 | ||
| 762 | idUser's I Dpathstrin g | |
| 763 | ||
| 764 | ||
| 765 | Response M essages | |
| 766 | HTTP Statu s | |
| 767 | CodeReason Response M odelHeader s | |
| 768 | ||
| 769 | ||
| 770 | ||
| 771 | ||
| 772 | ||
| 773 | 401Unautho rized | |
| 774 | ||
| 775 | 403Forbidd en | |
| 776 | ||
| 777 | 404Not Fou nd | |
| 778 | ||
| 779 | ||
| 780 | Try it out ! | |
| 781 | ||
| 782 | ||
| 783 | ||
| 784 | ||
| 785 | ||
| 786 | ||
| 787 | /services/ requests/{ id}/denyDe ny request | |
| 788 | ||
| 789 | Implementa tion Notes | |
| 790 | Modify and save chan ges to a r equest det ails | |
| 791 | ||
| 792 | Response C lass (Stat us 200) | |
| 793 | int32 | |
| 794 | ||
| 795 | Response C ontent Typ e I applic ation/json I | |
| 796 | ||
| 797 | Parameters | |
| 798 | ||
| 799 | Parameter | |
| 800 | Value | |
| 801 | Descriptio n | |
| 802 | Parameter Type | |
| 803 | Data Type | |
| 804 | id | |
| 805 | !(required ) | |
| 806 | RequestlD | |
| 807 | path | |
| 808 | integer | |
| 809 | ||
| 810 | ||
| 811 | ||
| 812 | request | |
| 813 | ||
| 814 | ||
| 815 | (required) | |
| 816 | ||
| 817 | Parameter content ty pe: | |
| 818 | I applicat ion/jsonI | |
| 819 | request de tails | |
| 820 | body | |
| 821 | Example Va lue | |
| 822 | ||
| 823 | ||
| 824 | Model | |
| 825 | I{ | |
| 826 | "approveri d ": "stri ng", "comm ents" : "s tring", "c reatedBy": "string", | |
| 827 | "createdOn ": "2017-0 6-12T14:45 :08.655Z", | |
| 828 | "descripti on": "stri ng", | |
| 829 | "id": 0, | |
| 830 | "modifiedB y" : "stri ng", | |
| 831 | "modifiedO n": "2017- 06-12T14:4 5:08.655Z" , | |
| 832 | "requestHi stories": [ | |
| 833 | { | |
| 834 | ||
| 835 | "aooroveri d": "strin e" . | |
| 836 | ||
| 837 | ||
| 838 | Response M essages | |
| 839 | ||
| 840 | CodeHTTP S tatusReaso n | |
| 841 | ||
| 842 | ||
| 843 | Response M odelHeader s | |
| 844 | ||
| 845 | ||
| 846 | 201Created | |
| 847 | ||
| 848 | 401Unautho rized | |
| 849 | ||
| 850 | 403Forbidd en | |
| 851 | ||
| 852 | ||
| 853 | 404Not Fou nd | |
| 854 | ||
| 855 | ||
| 856 | Try it out ! | |
| 857 | ||
| 858 | ||
| 859 | ||
| 860 | /services/ requests/{ id}/denyda ta | |
| 861 | ||
| 862 | Implementa tion Notes | |
| 863 | Modify and save chan ges to a r equest det ails | |
| 864 | ||
| 865 | ||
| 866 | Response C lass (Stat us 200) | |
| 867 | int32 | |
| 868 | ||
| 869 | ||
| 870 | Response C ontent Typ e I applic ation/json T I | |
| 871 | ||
| 872 | Parameters | |
| 873 | Un-fulfill request | |
| 874 | ||
| 875 | ||
| 876 | ||
| 877 | id | |
| 878 | !<required ) | |
| 879 | BeEFiBtiBR | |
| 880 | RequestlD | |
| 881 | path | |
| 882 | integer | |
| 883 | ||
| 884 | ||
| 885 | request | |
| 886 | ||
| 887 | ||
| 888 | (required) | |
| 889 | ||
| 890 | Parameter content ty pe: | |
| 891 | I applicat ion/json T I | |
| 892 | request de tails | |
| 893 | body | |
| 894 | Example Va lue | |
| 895 | ||
| 896 | ||
| 897 | Model | |
| 898 | {"approver id ": "str ing",I | |
| 899 | "comments" : "string" , | |
| 900 | "createdBy ": "strin g", | |
| 901 | "createdOn ": "2017-0 6-12T14:45 :08.667Z", | |
| 902 | "descripti on" : "str ing", | |
| 903 | 0 id 11 : 0, | |
| 904 | "modifiedB y": "strin g", | |
| 905 | "modifiedO n ": "2017 -06-12T14: 45:08.667Z ", | |
| 906 | "requestHi stories" : [ | |
| 907 | { | |
| 908 | ||
| 909 | "aooroveri d": "strin g". | |
| 910 | ||
| 911 | ||
| 912 | Response M essages | |
| 913 | ||
| 914 | CodeHTTP S tatusReaso n | |
| 915 | ||
| 916 | ||
| 917 | Response M odelHeader s | |
| 918 | ||
| 919 | ||
| 920 | 201Created | |
| 921 | ||
| 922 | 401Unautho rized | |
| 923 | ||
| 924 | ||
| 925 | 403Forbidd en | |
| 926 | ||
| 927 | 404Not Fou nd | |
| 928 | ||
| 929 | ||
| 930 | Try it out ! | |
| 931 | ||
| 932 | ||
| 933 | ||
| 934 | ||
| 935 | ||
| 936 | ||
| 937 | /services/ requests/{ id}/logGet s the requ est tracki ng by id | |
| 938 | ||
| 939 | Implementa tion Notes | |
| 940 | Retrives l ist of req uest histo ry for a g iven reque stld | |
| 941 | ||
| 942 | ||
| 943 | Response C lass (Stat us 200) | |
| 944 | Success | |
| 945 | ||
| 946 | ||
| 947 | ModelExamp le Value | |
| 948 | ||
| 949 | ||
| 950 | ||
| 951 | I{ | |
| 952 | "approveri d": "strin g", "creat edBy" : "s tring", | |
| 953 | "createdOn " : "2017- 06-12T14:4 5:08.672Z" , | |
| 954 | "descripti on": "stri ng", "hist lineNo": 0 , "modifie dBy": "str ing", | |
| 955 | "modifiedO n": "2017- 06-12T14:4 5:08.672Z" , | |
| 956 | "processid ": 0, | |
| 957 | ||
| 958 | ||
| 959 | ||
| 960 | Response C ontent Typ e I applic ation/json " I | |
| 961 | ||
| 962 | ||
| 963 | Parameters | |
| 964 | ||
| 965 | TypeParame terValueDe scriptionP arameter | |
| 966 | ||
| 967 | ||
| 968 | Data Type | |
| 969 | ||
| 970 | ||
| 971 | ||
| 972 | ||
| 973 | ||
| 974 | l<required )idRequest lDpath | |
| 975 | integer | |
| 976 | ||
| 977 | ||
| 978 | ||
| 979 | ||
| 980 | Response M essages | |
| 981 | ||
| 982 | HTTP Statu sCodeReaso nResponse Model | |
| 983 | 401Unautho rized | |
| 984 | ||
| 985 | ||
| 986 | ||
| 987 | Headers | |
| 988 | ||
| 989 | ||
| 990 | 403Forbidd en | |
| 991 | ||
| 992 | 404Not Fou nd | |
| 993 | ||
| 994 | ||
| 995 | Try it out ! | |
| 996 | ||
| 997 | ||
| 998 | ||
| 999 | ||
| 1000 | ||
| 1001 | ||
| 1002 | ||
| 1003 | -/services /requests/ {i d}/reje ctdata | |
| 1004 | ||
| 1005 | Implementa tion Notes | |
| 1006 | Modify and save chan ges to a r equest det ails | |
| 1007 | ||
| 1008 | ||
| 1009 | Response C lass (Stat us 200) | |
| 1010 | int32 | |
| 1011 | ||
| 1012 | ||
| 1013 | Response C ontent Typ e I applic ation/json " I | |
| 1014 | Parameters | |
| 1015 | ||
| 1016 | TypeParame terValueDe scriptionP arameter | |
| 1017 | ||
| 1018 | ||
| 1019 | ||
| 1020 | ||
| 1021 | ||
| 1022 | ||
| 1023 | ||
| 1024 | ||
| 1025 | ||
| 1026 | ||
| 1027 | ||
| 1028 | ||
| 1029 | ||
| 1030 | ||
| 1031 | ||
| 1032 | ||
| 1033 | ||
| 1034 | Data Type | |
| 1035 | Reject req uest | |
| 1036 | ||
| 1037 | ||
| 1038 | ||
| 1039 | ||
| 1040 | !<required )idRequest lDpathinte ger | |
| 1041 | ||
| 1042 | ||
| 1043 | TypeParame terValueDe scriptionP arameter | |
| 1044 | Data Type | |
| 1045 | ||
| 1046 | ||
| 1047 | ||
| 1048 | ||
| 1049 | request | |
| 1050 | ||
| 1051 | ||
| 1052 | (required) | |
| 1053 | ||
| 1054 | Parameter content ty pe: | |
| 1055 | I applicat ion/json • I | |
| 1056 | request de tails | |
| 1057 | body | |
| 1058 | Example Va lue | |
| 1059 | ||
| 1060 | ||
| 1061 | Model | |
| 1062 | I{ | |
| 1063 | "approveri d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 1064 | "createdOn ": "2017-0 6-12T14:45 :08.681Z", | |
| 1065 | "descripti on": "stri ng", | |
| 1066 | 11 id": 0 , | |
| 1067 | "modifiedB y ": "stri ng", | |
| 1068 | "modifiedO n" : "2017 -06-12T14: 45:08.681Z ", | |
| 1069 | "requestHi stories" : [ | |
| 1070 | { | |
| 1071 | ||
| 1072 | "aoorover d": "strin 2". | |
| 1073 | ||
| 1074 | ||
| 1075 | Response M essages | |
| 1076 | ||
| 1077 | CodeHTTP S tatusReaso n | |
| 1078 | ||
| 1079 | ||
| 1080 | Response M odel | |
| 1081 | ||
| 1082 | ||
| 1083 | Headers | |
| 1084 | ||
| 1085 | ||
| 1086 | 201Created | |
| 1087 | ||
| 1088 | ||
| 1089 | 401Unautho rized | |
| 1090 | ||
| 1091 | 403Forbidd en | |
| 1092 | ||
| 1093 | 404Not Fou nd | |
| 1094 | ||
| 1095 | ||
| 1096 | Try it out ! | |
| 1097 | ||
| 1098 | ||
| 1099 | ||
| 1100 | ||
| 1101 | ||
| 1102 | ||
| 1103 | - /service s/requests /{id}/resu ltsdel iv ered | |
| 1104 | ||
| 1105 | Implementa tion Notes | |
| 1106 | Modify and save chan ges to a r equest det ails | |
| 1107 | ||
| 1108 | Response C lass (Stat us 200) | |
| 1109 | int32 | |
| 1110 | ||
| 1111 | Response C ontent Typ e I applic ation/json • I | |
| 1112 | ||
| 1113 | Parameters | |
| 1114 | ParameterV alueDescri ption | |
| 1115 | ||
| 1116 | ||
| 1117 | ||
| 1118 | ||
| 1119 | ||
| 1120 | ||
| 1121 | ||
| 1122 | ||
| 1123 | ||
| 1124 | ||
| 1125 | ||
| 1126 | ||
| 1127 | ||
| 1128 | ||
| 1129 | ||
| 1130 | ||
| 1131 | ||
| 1132 | ||
| 1133 | ParameterD ata Type T ype | |
| 1134 | ||
| 1135 | Request De liver requ est | |
| 1136 | ||
| 1137 | ||
| 1138 | ||
| 1139 | ||
| 1140 | ||
| 1141 | ||
| 1142 | id!(requir ed)Request lDpath | |
| 1143 | integer | |
| 1144 | ||
| 1145 | ||
| 1146 | ||
| 1147 | ||
| 1148 | TypeParame terValueDe scriptionP arameter | |
| 1149 | Data Type | |
| 1150 | ||
| 1151 | ||
| 1152 | ||
| 1153 | ||
| 1154 | request | |
| 1155 | ||
| 1156 | ||
| 1157 | (required) | |
| 1158 | ||
| 1159 | Parameter content ty pe: | |
| 1160 | I applicat ion/json • I | |
| 1161 | request de tails | |
| 1162 | body | |
| 1163 | Example Va lue | |
| 1164 | ||
| 1165 | ||
| 1166 | Model | |
| 1167 | I{ | |
| 1168 | "approveri d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 1169 | "createdOn ": "2017-0 6-12T14:45 :08.701Z", | |
| 1170 | "descripti on": "stri ng", | |
| 1171 | 11 id": 0 , | |
| 1172 | "modifiedB y ": "stri ng", | |
| 1173 | "modifiedO n" : "2017 -06-12T14: 45:08.701Z ", | |
| 1174 | "requestHi stories" : [ | |
| 1175 | { | |
| 1176 | ||
| 1177 | "aoorover d": "strin 2". | |
| 1178 | ||
| 1179 | ||
| 1180 | Response M essages | |
| 1181 | ||
| 1182 | CodeHTTP S tatusReaso n | |
| 1183 | ||
| 1184 | 201Created | |
| 1185 | ||
| 1186 | m:rrp Stat us[J orize d Code | |
| 1187 | 403Forbidd en | |
| 1188 | ||
| 1189 | 404Not Fou nd | |
| 1190 | ||
| 1191 | ||
| 1192 | Try it out ! | |
| 1193 | ||
| 1194 | ||
| 1195 | Response M odelHeader s | |
| 1196 | ||
| 1197 | ||
| 1198 | ||
| 1199 | ||
| 1200 | Response M odelHeader s | |
| 1201 | ||
| 1202 | ||
| 1203 | ||
| 1204 | ||
| 1205 | ||
| 1206 | ||
| 1207 | /services/ requests/{ id}/return Return req uest | |
| 1208 | ||
| 1209 | Implementa tion Notes | |
| 1210 | Modify and save chan ges to a r equest det ails | |
| 1211 | ||
| 1212 | Response C lass (Stat us 200) | |
| 1213 | int32 | |
| 1214 | ||
| 1215 | Response C ontent Typ e I applic ation/json • I | |
| 1216 | ||
| 1217 | Parameters | |
| 1218 | ||
| 1219 | TypeParame terValueDe scriptionP arameterDa ta Type id !(required )RequestlD pathintege r | |
| 1220 | ||
| 1221 | ParameterV alueDescri ptionParam eter Type | |
| 1222 | Data Type | |
| 1223 | ||
| 1224 | ||
| 1225 | request | |
| 1226 | ||
| 1227 | ||
| 1228 | (required) | |
| 1229 | ||
| 1230 | Parameter content ty pe: | |
| 1231 | I applicat ion/json • I | |
| 1232 | ||
| 1233 | request de tails | |
| 1234 | ||
| 1235 | body | |
| 1236 | ||
| 1237 | ||
| 1238 | ModelExamp le Value | |
| 1239 | ||
| 1240 | ||
| 1241 | I{ | |
| 1242 | "approveri d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 1243 | "createdOn ": "2017-0 6-12T14:45 :08.713Z", | |
| 1244 | "descripti on": "stri ng", | |
| 1245 | 11 id": 0 , | |
| 1246 | "modifiedB y ": "stri ng", | |
| 1247 | "modifiedO n" : "2017 -06-12T14: 45:08.713Z ", | |
| 1248 | "requestHi stories" : [ | |
| 1249 | { | |
| 1250 | ||
| 1251 | "aoorover d": "strin 2". | |
| 1252 | ||
| 1253 | ||
| 1254 | Response M essages | |
| 1255 | ||
| 1256 | CodeHTTP S tatusReaso n | |
| 1257 | ||
| 1258 | ||
| 1259 | Response M odelHeader s | |
| 1260 | ||
| 1261 | ||
| 1262 | 201Created | |
| 1263 | ||
| 1264 | ||
| 1265 | ||
| 1266 | 401Unautho rized | |
| 1267 | ||
| 1268 | 11193P Sta tusR@mi@ e n Code | |
| 1269 | 404Not Fou nd | |
| 1270 | ||
| 1271 | ||
| 1272 | Try it out ! | |
| 1273 | ||
| 1274 | ||
| 1275 | ||
| 1276 | Response M odelHeader s | |
| 1277 | ||
| 1278 | ||
| 1279 | ||
| 1280 | ||
| 1281 | ||
| 1282 | ||
| 1283 | /services/ requests/{ id}/sentSe nt request | |
| 1284 | ||
| 1285 | Implementa tion Notes | |
| 1286 | Modify and save chan ges to a r equest det ails | |
| 1287 | ||
| 1288 | Response C lass (Stat us 200) | |
| 1289 | int32 | |
| 1290 | ||
| 1291 | Response C ontent Typ e I applic ation/json • I | |
| 1292 | ||
| 1293 | Parameters | |
| 1294 | ||
| 1295 | TypeParame terValueDe scriptionP arameterDa ta Type | |
| 1296 | ||
| 1297 | ||
| 1298 | ||
| 1299 | ||
| 1300 | id!(requir ed)Request lDpathinte ger | |
| 1301 | ||
| 1302 | ||
| 1303 | ||
| 1304 | TypeParame terValueDe scriptionP arameter | |
| 1305 | Data Type | |
| 1306 | ||
| 1307 | ||
| 1308 | ||
| 1309 | ||
| 1310 | request | |
| 1311 | ||
| 1312 | ||
| 1313 | (required) | |
| 1314 | ||
| 1315 | Parameter content ty pe: | |
| 1316 | I applicat ion/json • I | |
| 1317 | request de tails | |
| 1318 | body | |
| 1319 | Example Va lue | |
| 1320 | ||
| 1321 | ||
| 1322 | Model | |
| 1323 | I{ | |
| 1324 | "approveri d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 1325 | "createdOn ": "2017-0 6-12T14:45 :08.724Z", | |
| 1326 | "descripti on": "stri ng", | |
| 1327 | 11 id": 0 , | |
| 1328 | "modifiedB y ": "stri ng", | |
| 1329 | "modifiedO n" : "2017 -06-12T14: 45:08.724Z ", | |
| 1330 | "requestHi stories" : [ | |
| 1331 | { | |
| 1332 | ||
| 1333 | "aoorover d": "strin 2". | |
| 1334 | ||
| 1335 | ||
| 1336 | Response M essages | |
| 1337 | ||
| 1338 | CodeHTTP S tatusReaso n | |
| 1339 | ||
| 1340 | 201Created | |
| 1341 | ||
| 1342 | 401Unautho rized | |
| 1343 | ||
| 1344 | 403Forbidd en | |
| 1345 | i:StatusRe Marund | |
| 1346 | Try it out ! | |
| 1347 | ||
| 1348 | ||
| 1349 | Response M odelHeader s | |
| 1350 | ||
| 1351 | ||
| 1352 | ||
| 1353 | ||
| 1354 | ||
| 1355 | ||
| 1356 | ||
| 1357 | ||
| 1358 | Response M odelHeader s | |
| 1359 | ||
| 1360 | ||
| 1361 | ||
| 1362 | ||
| 1363 | ||
| 1364 | ||
| 1365 | - /service s/requests /{id}/subm itSubmit r equest | |
| 1366 | ||
| 1367 | Implementa tion Notes | |
| 1368 | Modify and save chan ges to a r equest det ails | |
| 1369 | ||
| 1370 | Response C lass (Stat us 200) | |
| 1371 | int32 | |
| 1372 | ||
| 1373 | Response C ontent Typ e I applic ation/json • I | |
| 1374 | ||
| 1375 | Parameters | |
| 1376 | ||
| 1377 | TypeParame terValueDe scriptionP arameterDa ta Type id !(required )RequestlD pathintege r | |
| 1378 | ||
| 1379 | ParameterV alueDescri ptionParam eter Type | |
| 1380 | Data Type | |
| 1381 | ||
| 1382 | request | |
| 1383 | ||
| 1384 | ||
| 1385 | (required) | |
| 1386 | ||
| 1387 | Parameter content ty pe: | |
| 1388 | I applicat ion/json • I | |
| 1389 | ||
| 1390 | request de tails | |
| 1391 | ||
| 1392 | body | |
| 1393 | ||
| 1394 | ||
| 1395 | ModelExamp le Value | |
| 1396 | ||
| 1397 | ||
| 1398 | I{ | |
| 1399 | "approveri d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 1400 | "createdOn ": "2017-0 6-12T14:45 :08.738Z", | |
| 1401 | "descripti on": "stri ng", | |
| 1402 | 11 id": 0 , | |
| 1403 | "modifiedB y ": "stri ng", | |
| 1404 | "modifiedO n" : "2017 -06-12T14: 45:08.738Z ", | |
| 1405 | "requestHi stories" : [ | |
| 1406 | { | |
| 1407 | ||
| 1408 | "aoorover d": "strin 2". | |
| 1409 | ||
| 1410 | Response M essages | |
| 1411 | HTTP Statu s | |
| 1412 | CodeReason Response M odelHeader s | |
| 1413 | ||
| 1414 | ||
| 1415 | 201Created | |
| 1416 | ||
| 1417 | ||
| 1418 | 401Unautho rized | |
| 1419 | ||
| 1420 | 403Forbidd en | |
| 1421 | ||
| 1422 | 404Not Fou nd | |
| 1423 | ||
| 1424 | ||
| 1425 | ||
| 1426 | HJTF.t' St atud:R!Je! out!Reaso nResponse ModelHeade rs | |
| 1427 | ||
| 1428 | ||
| 1429 | ||
| 1430 | ||
| 1431 | /services/ requests/{ requestld} /copytable Performs t he table c opy script execution | |
| 1432 | ||
| 1433 | Implementa tion Notes | |
| 1434 | This will copy table from VINC I using re quest id a nd copy ta ble source | |
| 1435 | ||
| 1436 | Response C lass (Stat us 200) | |
| 1437 | string | |
| 1438 | ||
| 1439 | Response C ontent Typ e I applic ation/json • I | |
| 1440 | ||
| 1441 | Parameters | |
| 1442 | ||
| 1443 | !<required )Parameter ValueDescr iptionmete r Data T ype | |
| 1444 | ||
| 1445 | ||
| 1446 | ||
| 1447 | requestid | |
| 1448 | Request | |
| 1449 | Id | |
| 1450 | pathintege r | |
| 1451 | ||
| 1452 | ||
| 1453 | (required) | |
| 1454 | ModelParam eterValueD escription Parame ter Data Type Type | |
| 1455 | ||
| 1456 | ||
| 1457 | ||
| 1458 | copyTableS ource | |
| 1459 | Copy table | |
| 1460 | body | |
| 1461 | Example Va lue | |
| 1462 | ||
| 1463 | ||
| 1464 | ||
| 1465 | ||
| 1466 | ||
| 1467 | ||
| 1468 | ||
| 1469 | Parameter content ty pe: | |
| 1470 | I applicat ion/json T I | |
| 1471 | source{ | |
| 1472 | ||
| 1473 | "cmdFilePa th": "stri ng", "dest inationSch emaName": "string", "sourceSc hemaName" : "string" , "tableNa me": "stri ng", "tcDe stinationD ataBaseSch ema" : "st ring", | |
| 1474 | "tcDestina tionDataBa seServerNa me": "str ing", "tcD estination DataBaseUs erName": "string", "tcDestina tionDataBa seUserPass word" : "s tring", "t cDestinati onServerDa taBaseName ": "strin g", "tcMan agementDat aBaseName" : "string ", "tcMana 2ementData BaseSchema ": "strin 2". | |
| 1475 | ||
| 1476 | ||
| 1477 | ||
| 1478 | Response M essages | |
| 1479 | ||
| 1480 | CodeHTTP S tatusReaso n | |
| 1481 | ||
| 1482 | ||
| 1483 | Response M odelHeader s | |
| 1484 | ||
| 1485 | ||
| 1486 | 201Created | |
| 1487 | ||
| 1488 | 401Unautho rized | |
| 1489 | ||
| 1490 | 403Forbidd en | |
| 1491 | ||
| 1492 | 404Not Fou nd | |
| 1493 | ||
| 1494 | ||
| 1495 | Try it out ! | |
| 1496 | ||
| 1497 | ||
| 1498 | ||
| 1499 | ||
| 1500 | ||
| 1501 | /services/ requests/{ status}/st atusGets t he request by status | |
| 1502 | ||
| 1503 | Implementa tion Notes | |
| 1504 | Returns a list of al l requests with a sp ecific sta tus in the Genisis2 | |
| 1505 | ||
| 1506 | Response C lass (Stat us 200) | |
| 1507 | Success | |
| 1508 | ||
| 1509 | ||
| 1510 | .. | |
| 1511 | Model | |
| 1512 | •Example V alue | |
| 1513 | ||
| 1514 | ||
| 1515 | { | |
| 1516 | "approveri d ": "stri ng", "comm ents": "st ring", "cr eatedBy": "string", | |
| 1517 | "createdOn ": "2017-0 6-12T14:45 :08.756Z", | |
| 1518 | "descripti on": "stri ng", "id": 0, | |
| 1519 | ||
| 1520 | "modifiedB y ": "stri ng", | |
| 1521 | "modifiedO n ": "2017 -06-12T14: 45:08.756Z ", | |
| 1522 | .... | |
| 1523 | ||
| 1524 | ||
| 1525 | ||
| 1526 | ||
| 1527 | Response Content T ype I appl ication/js on T I | |
| 1528 | ||
| 1529 | ||
| 1530 | Parameters | |
| 1531 | ||
| 1532 | TypeParame terValueDe scriptionP arameter | |
| 1533 | ||
| 1534 | ||
| 1535 | Data Type | |
| 1536 | ||
| 1537 | ||
| 1538 | ||
| 1539 | ||
| 1540 | ||
| 1541 | ||
| 1542 | status | |
| 1543 | The status of the re questpath | |
| 1544 | string | |
| 1545 | ||
| 1546 | ||
| 1547 | ||
| 1548 | ||
| 1549 | Response M essages | |
| 1550 | ||
| 1551 | ReasonHTTP Status Co de | |
| 1552 | ||
| 1553 | ||
| 1554 | ||
| 1555 | Response M odelHeader s | |
| 1556 | ||
| 1557 | ||
| 1558 | ||
| 1559 | 401Unautho rized | |
| 1560 | ||
| 1561 | 403Forbidd en | |
| 1562 | ||
| 1563 | 404Not Fou nd | |
| 1564 | ||
| 1565 | ||
| 1566 | Try it out ! | |
| 1567 | ||
| 1568 | ||
| 1569 | ||
| 1570 | ||
| 1571 | ||
| 1572 | ||
| 1573 | ||
| 1574 | ||
| 1575 | /services/ requests/{ uid}/creat edBy | |
| 1576 | ||
| 1577 | Implementa tion Notes | |
| 1578 | Returns a list of al l requests for a spe cific user | |
| 1579 | ||
| 1580 | ||
| 1581 | Response C lass (Stat us 200) | |
| 1582 | Success | |
| 1583 | Gets the r equests by user | |
| 1584 | ||
| 1585 | ||
| 1586 | ||
| 1587 | ModelExamp le Value | |
| 1588 | ||
| 1589 | ||
| 1590 | {"approver id": "stri ng",I | |
| 1591 | "comments" : "string" , "created By": "stri ng", | |
| 1592 | "createdOn ": "2017-0 6-12T14:45 :08.772Z", | |
| 1593 | "descripti on": "stri ng", "id": 0, | |
| 1594 | "modifiedB y": "strin g", | |
| 1595 | "modifiedO n": "2017- 06-12T14:4 5:08.772Z" , | |
| 1596 | "requestHi stories": | |
| 1597 | I | |
| 1598 | ||
| 1599 | Response Content T ype I appl ication/js on T I | |
| 1600 | ||
| 1601 | ||
| 1602 | Parameters | |
| 1603 | ||
| 1604 | !<required ) | |
| 1605 | TypeParame terValueDe scriptionP arameter | |
| 1606 | ||
| 1607 | ||
| 1608 | Data Type | |
| 1609 | ||
| 1610 | ||
| 1611 | ||
| 1612 | ||
| 1613 | uid | |
| 1614 | Request ID path | |
| 1615 | string | |
| 1616 | ||
| 1617 | ||
| 1618 | ||
| 1619 | ||
| 1620 | Response M essages | |
| 1621 | HTTP Statu s | |
| 1622 | CodeReason Response M odel | |
| 1623 | ||
| 1624 | ||
| 1625 | ||
| 1626 | Headers | |
| 1627 | ||
| 1628 | ||
| 1629 | ||
| 1630 | ||
| 1631 | ||
| 1632 | ||
| 1633 | 401Unautho rized | |
| 1634 | ||
| 1635 | 403Forbidd en | |
| 1636 | ||
| 1637 | 404Not Fou nd | |
| 1638 | ||
| 1639 | ||
| 1640 | Try it out ! | |
| 1641 | ||
| 1642 | ||
| 1643 | ||
| 1644 | ||
| 1645 | ||
| 1646 | ||
| 1647 | studyAppro vals : stu dyApproval s API | |
| 1648 | ||
| 1649 | ||
| 1650 | /services/ requests/{ studyAppro vall d}/ studyAppro valGets th e all requ ests by st udy approv al | |
| 1651 | ||
| 1652 | Implementa tion Notes | |
| 1653 | Returns a list of re quests tha t are link ed to the study appr oval | |
| 1654 | ||
| 1655 | Response C lass (Stat us 200) | |
| 1656 | Success | |
| 1657 | ||
| 1658 | ||
| 1659 | ModelExamp le Value | |
| 1660 | ||
| 1661 | ||
| 1662 | { | |
| 1663 | . | |
| 1664 | .. | |
| 1665 | ||
| 1666 | "approveri d ": "stri ng",I | |
| 1667 | "comments" : "string" , "created By ": "str ing", | |
| 1668 | "createdOn ": "2017-0 6-12T14:45 :08.788Z", | |
| 1669 | "descripti on ": "str ing", "id" : 0, | |
| 1670 | "modifiedB y ": "stri ng", | |
| 1671 | "modifiedO n": "2017- 06-12T14:4 5:08.788Z" , | |
| 1672 | "requestHi stories ": | |
| 1673 | I | |
| 1674 | ||
| 1675 | Response C ontent Typ e I applic ation/json T I | |
| 1676 | ||
| 1677 | ||
| 1678 | Parameters | |
| 1679 | ||
| 1680 | TypeParame terValueDe scriptionP arameter | |
| 1681 | ||
| 1682 | ||
| 1683 | Data Type | |
| 1684 | ||
| 1685 | ||
| 1686 | ||
| 1687 | ||
| 1688 | ||
| 1689 | !<required )studyAppr ovalid | |
| 1690 | Study Appr oval IDpa thinteger | |
| 1691 | ||
| 1692 | ||
| 1693 | ||
| 1694 | Response M essages | |
| 1695 | ||
| 1696 | HTTP Statu sCodeReaso nResponse ModelHeade rs | |
| 1697 | ||
| 1698 | ||
| 1699 | 401Unautho rized | |
| 1700 | ||
| 1701 | 403Forbidd en | |
| 1702 | ||
| 1703 | 404Not Fou nd | |
| 1704 | ||
| 1705 | ||
| 1706 | Try it out ! | |
| 1707 | ||
| 1708 | ||
| 1709 | ||
| 1710 | - /service s/studyApp rovalsGets the all s tudy appro vals | |
| 1711 | ||
| 1712 | Implementa tion Notes | |
| 1713 | Returns a list of al l study ap provals in Genisis2 | |
| 1714 | ||
| 1715 | ||
| 1716 | Response C lass (Stat us 200) | |
| 1717 | Success | |
| 1718 | ||
| 1719 | ||
| 1720 | ModelExamp le Value | |
| 1721 | ||
| 1722 | ||
| 1723 | ||
| 1724 | I{ | |
| 1725 | "approvali dObtained ": "string ", "associ atedApprov als" : | |
| 1726 | 0 | |
| 1727 | ], | |
| 1728 | "associate dStudyAppr ovall ": 0 , | |
| 1729 | "associate dStudyAppr oval2 ": 0 , | |
| 1730 | "associate dStudyAppr oval3 ": 0 , "created By ": "str ing", | |
| 1731 | ||
| 1732 | ||
| 1733 | Response C ontent Typ e I applic ation/json T I | |
| 1734 | ||
| 1735 | Response M essages | |
| 1736 | ||
| 1737 | HTTP Statu s | |
| 1738 | : | |
| 1739 | Status | |
| 1740 | Seastbhori zed | |
| 1741 | Response M odel | |
| 1742 | 403 | |
| 1743 | ||
| 1744 | Forbidden | |
| 1745 | ||
| 1746 | 404 | |
| 1747 | ||
| 1748 | Not Found | |
| 1749 | ||
| 1750 | CodeReason Response M odelHeader s Headers | |
| 1751 | ||
| 1752 | ||
| 1753 | ||
| 1754 | ||
| 1755 | ||
| 1756 | Try it out ! | |
| 1757 | ||
| 1758 | ||
| 1759 | ||
| 1760 | ||
| 1761 | ||
| 1762 | - /service s/studyApp rovalsCrea tes the st udy approv al | |
| 1763 | ||
| 1764 | Implementa tion Notes | |
| 1765 | This call will creat e a new st udy approv al. Body c ontains th e ID of th e user mak ing the AP I call for permissio ns checkin g and audi t logs. | |
| 1766 | ||
| 1767 | Response C lass (Stat us 200) | |
| 1768 | int32 | |
| 1769 | ||
| 1770 | ||
| 1771 | Response C ontent Typ e I applic ation/json T I | |
| 1772 | ||
| 1773 | Parameters | |
| 1774 | ||
| 1775 | TypeParame terValueDe scription Parameter Data Typ e | |
| 1776 | ||
| 1777 | ||
| 1778 | ||
| 1779 | ||
| 1780 | ||
| 1781 | ||
| 1782 | ||
| 1783 | (required) studyAppro val | |
| 1784 | Study Appr oval detai ls | |
| 1785 | body | |
| 1786 | Example Va lue | |
| 1787 | ||
| 1788 | ||
| 1789 | Model | |
| 1790 | I{ | |
| 1791 | "approvali dObtained" : "string ", "associ atedApprov als ": | |
| 1792 | 0 | |
| 1793 | ||
| 1794 | ||
| 1795 | Parameter content ty pe: | |
| 1796 | Iapplicati on/json - . I | |
| 1797 | ], | |
| 1798 | "associate dStudyAppr ovall" : 0 , | |
| 1799 | "associate dStudyAppr oval2": 0 , | |
| 1800 | "associate dStudyAppr oval3": 0, "createdB y": "strin g", | |
| 1801 | "createdOn " : "2017- 06-12T14:4 5:08.808Z" , | |
| 1802 | "descripti on ": "str ing", | |
| 1803 | "id" : 0 . | |
| 1804 | ||
| 1805 | ||
| 1806 | ||
| 1807 | Response M essages | |
| 1808 | ||
| 1809 | CodeHTTP S tatusReaso n | |
| 1810 | ||
| 1811 | ||
| 1812 | Response M odel | |
| 1813 | ||
| 1814 | ||
| 1815 | Headers | |
| 1816 | ||
| 1817 | ||
| 1818 | 201Created | |
| 1819 | ||
| 1820 | 401Unautho rized | |
| 1821 | ||
| 1822 | 403Forbidd en | |
| 1823 | ||
| 1824 | 404Not Fou nd | |
| 1825 | ||
| 1826 | ||
| 1827 | Try it out ! | |
| 1828 | ||
| 1829 | ||
| 1830 | ||
| 1831 | ||
| 1832 | ||
| 1833 | ||
| 1834 | /services/ studyAppro vals/{id}G ets the st udy approv al by id | |
| 1835 | ||
| 1836 | Implementa tion Notes | |
| 1837 | Returns a list of St udyApprova l for a gi ven Study Approval I d | |
| 1838 | ||
| 1839 | ||
| 1840 | Response C lass (Stat us 200) | |
| 1841 | Success | |
| 1842 | ||
| 1843 | ||
| 1844 | ModelExamp le Value | |
| 1845 | ||
| 1846 | ||
| 1847 | {"approval idObtained ": "strin g",I | |
| 1848 | "associate dApprovals ": | |
| 1849 | 0 | |
| 1850 | ], | |
| 1851 | "associate dStudyAppr ovall" : 0 , | |
| 1852 | "associate dStudyAppr oval2 ": 0 , | |
| 1853 | "associate dStudyAppr oval3 ": 0 , "created By": "stri ng", | |
| 1854 | "createdOn " : "2017- 06-12T14:4 5:08.817Z" , | |
| 1855 | ||
| 1856 | ||
| 1857 | ||
| 1858 | Response C ontent Typ e I applic ation/json -. I | |
| 1859 | ||
| 1860 | Parameters | |
| 1861 | ||
| 1862 | ||
| 1863 | TypeParame terValueDe scriptionP arameter | |
| 1864 | Data Type | |
| 1865 | ||
| 1866 | ||
| 1867 | ||
| 1868 | ||
| 1869 | l<required )idStudy A pproval ID pathintege r | |
| 1870 | ||
| 1871 | ||
| 1872 | Response M essages | |
| 1873 | ||
| 1874 | HTTP Statu sCodeReaso nResponse ModelHeade rs | |
| 1875 | ||
| 1876 | ||
| 1877 | 401Unautho rized | |
| 1878 | ||
| 1879 | 403Forbidd en | |
| 1880 | ||
| 1881 | 404Not Fou nd | |
| 1882 | ||
| 1883 | ||
| 1884 | Try it out ! | |
| 1885 | ||
| 1886 | ||
| 1887 | ||
| 1888 | ||
| 1889 | ||
| 1890 | ||
| 1891 | -/services /studyAppr ovals/{id} Update stu dy approva l | |
| 1892 | ||
| 1893 | Implementa tion Notes | |
| 1894 | Modify and save chan ges to a s tudy appro val | |
| 1895 | ||
| 1896 | ||
| 1897 | Response C lass (Stat us 200) | |
| 1898 | int32 | |
| 1899 | ||
| 1900 | ||
| 1901 | Response C ontent Typ e I applic ation/json ,. I | |
| 1902 | ||
| 1903 | Parameters | |
| 1904 | ||
| 1905 | TypeParame terValueDe scription Parameter Data Typ e | |
| 1906 | ||
| 1907 | ||
| 1908 | ||
| 1909 | ||
| 1910 | !<required )idStudypa th | |
| 1911 | Approval I D | |
| 1912 | integer | |
| 1913 | ||
| 1914 | ||
| 1915 | ||
| 1916 | ||
| 1917 | studyAppro val | |
| 1918 | ||
| 1919 | ||
| 1920 | (required) | |
| 1921 | ||
| 1922 | Parameter content ty pe: | |
| 1923 | Iapplicati on/json " I | |
| 1924 | Studybody Approval | |
| 1925 | details | |
| 1926 | Example Va lue | |
| 1927 | ||
| 1928 | ||
| 1929 | Model | |
| 1930 | I{ | |
| 1931 | "approvali dObtained" : "string ", "associ atedApprov als": | |
| 1932 | 0 | |
| 1933 | ] ' | |
| 1934 | "associate dStudyApp rovall": 0 , "associa tedStudyAp proval2 ": 0, | |
| 1935 | "associate dStudyAppr oval3": 0, "createdB y" : "stri ng", | |
| 1936 | "createdOn ": "2017-0 6-12T14:45 :08.829Z", | |
| 1937 | "descripti on": "stri ng", "id": 0. | |
| 1938 | ||
| 1939 | ||
| 1940 | Response M essages | |
| 1941 | ||
| 1942 | HTTP Statu sCodeReaso nResponse ModelHeade rs | |
| 1943 | ||
| 1944 | ||
| 1945 | ||
| 1946 | ||
| 1947 | ||
| 1948 | 201Created | |
| 1949 | ||
| 1950 | 401Unautho rized | |
| 1951 | ||
| 1952 | 403Forbidd en | |
| 1953 | ||
| 1954 | ||
| 1955 | 404Not Fou nd | |
| 1956 | ||
| 1957 | ||
| 1958 | Try it out ! | |
| 1959 | ||
| 1960 | ||
| 1961 | ||
| 1962 | ||
| 1963 | ||
| 1964 | ||
| 1965 | /services/ studyAppro vals/{uid} /{user}Get s the stud y approval by user | |
| 1966 | ||
| 1967 | Implementa tion Notes | |
| 1968 | Returns a list of St udyApprova l for a gi ven User I d | |
| 1969 | ||
| 1970 | ||
| 1971 | Response C lass (Stat us 200) | |
| 1972 | Success | |
| 1973 | ||
| 1974 | ||
| 1975 | ModelExamp le Value | |
| 1976 | ||
| 1977 | ||
| 1978 | {"approval idObtained ": "strin g",I | |
| 1979 | "associate dApprovals ": | |
| 1980 | 0 | |
| 1981 | ], | |
| 1982 | "associate dStudyAppr ovall" : 0 , | |
| 1983 | "associate dStudyAppr oval2 ": 0 , | |
| 1984 | "associate dStudyAppr oval3": 0, "createdB y": "strin g", | |
| 1985 | "createdOn ": "2017-0 6-12T14:45 :08.837Z", | |
| 1986 | ||
| 1987 | ||
| 1988 | ||
| 1989 | Response C ontent Typ e I applic ation/json T I | |
| 1990 | ||
| 1991 | ||
| 1992 | Parameters | |
| 1993 | ||
| 1994 | TypeParame terValueDe scriptionP arameter | |
| 1995 | ||
| 1996 | ||
| 1997 | Data Type | |
| 1998 | ||
| 1999 | ||
| 2000 | ||
| 2001 | ||
| 2002 | !<required )uidUser I Dpathstrin g | |
| 2003 | ||
| 2004 | ||
| 2005 | Response M essages | |
| 2006 | ||
| 2007 | HTTP Statu sCodeReaso nResponse ModelHeade rs | |
| 2008 | ||
| 2009 | ||
| 2010 | 401Unautho rized | |
| 2011 | ||
| 2012 | 403Forbidd en | |
| 2013 | ||
| 2014 | 404Not Fou nd | |
| 2015 | ||
| 2016 | ||
| 2017 | Try it out ! | |
| 2018 | ||
| 2019 | ||
| 2020 | ||
| 2021 | ||
| 2022 | ||
| 2023 | users : us ers API | |
| 2024 | ||
| 2025 | ||
| 2026 | /services/ users/role /{uid}Gets the user role by ui d | |
| 2027 | ||
| 2028 | Implementa tion Notes | |
| 2029 | Return Use r Role inf ormation o n a user I D | |
| 2030 | ||
| 2031 | Response C lass (Stat us 200) | |
| 2032 | string | |
| 2033 | ||
| 2034 | Response C ontent Typ e I applic ation/json I | |
| 2035 | ||
| 2036 | ||
| 2037 | Parameters | |
| 2038 | ||
| 2039 | TypeParame terValueDe scriptionP arameter | |
| 2040 | ||
| 2041 | ||
| 2042 | Data Type | |
| 2043 | ||
| 2044 | ||
| 2045 | ||
| 2046 | ||
| 2047 | userId | |
| 2048 | Parameter | |
| 2049 | j(required ) | |
| 2050 | v o1ue | |
| 2051 | User's ID number | |
| 2052 | ||
| 2053 | Descriptio n\lameterT ype | |
| 2054 | ||
| 2055 | ||
| 2056 | ||
| 2057 | ||
| 2058 | ||
| 2059 | Response M essages | |
| 2060 | ||
| 2061 | HTTP Statu sCodeReaso nResponse Model | |
| 2062 | 401Unautho rized | |
| 2063 | ||
| 2064 | ||
| 2065 | Headers | |
| 2066 | ||
| 2067 | ||
| 2068 | 403Forbidd en | |
| 2069 | ||
| 2070 | 404Not Fou nd | |
| 2071 | ||
| 2072 | ||
| 2073 | Try it out ! | |
| 2074 | ||
| 2075 | ||
| 2076 | ||
| 2077 | ||
| 2078 | ||
| 2079 | ||
| 2080 | ||
| 2081 | /services/ users/{ema il}/email | |
| 2082 | ||
| 2083 | Implementa tion Notes | |
| 2084 | Return inf ormation o n a user w ith the em ail addres s | |
| 2085 | ||
| 2086 | Response C lass (Stat us 200) | |
| 2087 | Success | |
| 2088 | Gets the u ser detail s by email | |
| 2089 | ||
| 2090 | ||
| 2091 | ||
| 2092 | ModelExamp le Value | |
| 2093 | ||
| 2094 | ||
| 2095 | I{ | |
| 2096 | "activeDat e": "2017- 06-12T14:4 5:08.865Z" , | |
| 2097 | "approver ": "string ", | |
| 2098 | "createDat e": "2017- 06-12T14:4 5:08.865Z" , | |
| 2099 | "emailid": "string", "firstNam e": "strin g", | |
| 2100 | "inactiveD ate ": "20 17-06-12T1 4:45:08.86 5Z", | |
| 2101 | "lastName" : "string" , "lastNam e2": "stri ng", "midd leName": " string", | |
| 2102 | n ...,.... . 1,... n • 11 ,, .-1- .... 4 .-.. rr " | |
| 2103 | ||
| 2104 | Response C ontent Typ e I applic ation/json I | |
| 2105 | ||
| 2106 | ||
| 2107 | Parameters | |
| 2108 | ||
| 2109 | !<required ) | |
| 2110 | TypeParame terValueDe scriptionP arameter | |
| 2111 | ||
| 2112 | ||
| 2113 | Data Type | |
| 2114 | ||
| 2115 | ||
| 2116 | ||
| 2117 | ||
| 2118 | ||
| 2119 | User's ema il address path | |
| 2120 | string | |
| 2121 | ||
| 2122 | ||
| 2123 | ||
| 2124 | ||
| 2125 | Response M essages | |
| 2126 | ||
| 2127 | HTTP Statu sCodeReaso nResponse Model | |
| 2128 | ||
| 2129 | ||
| 2130 | ||
| 2131 | Headers | |
| 2132 | ||
| 2133 | ||
| 2134 | ||
| 2135 | 401Unautho rized | |
| 2136 | ||
| 2137 | 403Forbidd en | |
| 2138 | ||
| 2139 | 404Not Fou nd | |
| 2140 | ||
| 2141 | ||
| 2142 | Try it out ! | |
| 2143 | ||
| 2144 | ||
| 2145 | ||
| 2146 | ||
| 2147 | ||
| 2148 | ||
| 2149 | ||
| 2150 | /services/ users/{id} | |
| 2151 | ||
| 2152 | Implementa tion Notes | |
| 2153 | This call will retri eve inform ation for the user w ith the id of resear cher | |
| 2154 | ||
| 2155 | ||
| 2156 | Response C lass (Stat us 200) | |
| 2157 | Success | |
| 2158 | Gets the u ser detail s by ID | |
| 2159 | ||
| 2160 | ||
| 2161 | ||
| 2162 | ModelExamp le Value | |
| 2163 | ||
| 2164 | ||
| 2165 | I{ | |
| 2166 | "activeDat e": "2017- 06-12T14:4 5:08.872Z" , | |
| 2167 | "approver ": "string ", | |
| 2168 | "createDat e": "2017- 06-12T14:4 5:08.872Z" , | |
| 2169 | "emailid": "string", "firstNam e": "strin g", | |
| 2170 | "inactiveD ate ": "20 17-06-12T1 4:45:08.87 2Z", | |
| 2171 | "lastName" : "string ", "lastNa me2": "str ing", "mid dleName": "string", | |
| 2172 | """'"1,.. n . tt ,.. +""'4 ""f' T " | |
| 2173 | ||
| 2174 | Response C ontent Typ e I applic ation/json I | |
| 2175 | ||
| 2176 | ||
| 2177 | Parameters | |
| 2178 | ||
| 2179 | TypeParame terValueDe scriptionP arameter | |
| 2180 | ||
| 2181 | ||
| 2182 | Data Type | |
| 2183 | ||
| 2184 | ||
| 2185 | ||
| 2186 | ||
| 2187 | ||
| 2188 | !<required )idUser's ID numberp ath | |
| 2189 | integer | |
| 2190 | ||
| 2191 | ||
| 2192 | ||
| 2193 | Response M essages | |
| 2194 | ||
| 2195 | ||
| 2196 | HTTP Statu sCodeReaso nResponse ModelHeade rs | |
| 2197 | ||
| 2198 | ||
| 2199 | 401Unautho rized | |
| 2200 | ||
| 2201 | ||
| 2202 | 403Forbidd en | |
| 2203 | ||
| 2204 | 404Not Fou nd | |
| 2205 | ||
| 2206 | ||
| 2207 | Try it out ! | |
| 2208 | ||
| 2209 | ||
| 2210 | ||
| 2211 | ||
| 2212 | ||
| 2213 | ||
| 2214 | [ BASE URL : /Genisis 2Services ' API VERS ION: 4.0.0 ] |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.