Skip to Content
Last modified by Admin on 2025/06/27 12:14
From version 15.1
edited by mikef
on 2017/05/04 11:57
Change comment: There is no comment for this version
To version 7.1
edited by Admin
on 2017/04/05 10:57
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.mikef
1 +XWiki.Admin
Content
... ... @@ -2,7 +2,7 @@
2 2  **Introduction**
3 3  
4 4  (% class="western" %)
5 -ONEcount REST API is designed to allow you to directly manipulate the underlying data within the ONEcount application. This API can be used to lookup, create and update different ONEcount data components which are listed below.
5 +ONEcount REST API is designed to allow you to directly manipulate the underlying data within the ONEcount application. This API can be used to lookup, create and updated different ONEcount data components which are listed below.
6 6  
7 7  (% class="western" %)
8 8  REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following:
... ... @@ -9,7 +9,7 @@
9 9  
10 10  1. (((
11 11  (% class="western" %)
12 -**GET** - Used for lookup of resourcesresources
12 +**GET** - Used for lookup of resources
13 13  )))
14 14  1. (((
15 15  (% class="western" %)
... ... @@ -249,7 +249,6 @@
249 249  
250 250  
251 251  
252 -(% class="wrapped" %)
253 253  |(((
254 254  (% class="western" %)
255 255  **Method**
... ... @@ -369,7 +369,6 @@
369 369  (% class="western" %)
370 370  **GET method should be used to lookup users.**
371 371  
372 -(% class="wrapped" %)
373 373  |(((
374 374  (% class="western" %)
375 375  **Request**
... ... @@ -401,7 +401,6 @@
401 401  
402 402  
403 403  
404 -(% class="wrapped" %)
405 405  |(((
406 406  (% class="western" %)
407 407  **Response**
... ... @@ -428,7 +428,6 @@
428 428  (% class="western" %)
429 429  **POST method should be used to create users.**
430 430  
431 -(% class="wrapped" %)
432 432  |(((
433 433  (% class="western" %)
434 434  **Request**
... ... @@ -480,7 +480,6 @@
480 480  CSV of ONEcount QuestionId's requested back in Users object in response.
481 481  )))
482 482  
483 -(% class="wrapped" %)
484 484  |(((
485 485  (% class="western" %)
486 486  **Response**
... ... @@ -507,7 +507,6 @@
507 507  (% class="western" %)
508 508  **PUT method should be used to update users.**
509 509  
510 -(% class="wrapped" %)
511 511  |(((
512 512  (% class="western" %)
513 513  **Request**
... ... @@ -549,7 +549,6 @@
549 549  RequestDate to use for the demo update. If not provided current date will be used.
550 550  )))
551 551  
552 -(% class="wrapped" %)
553 553  |(((
554 554  (% class="western" %)
555 555  **Response**
... ... @@ -942,7 +942,7 @@
942 942  }
943 943  
944 944  (% class="western" %)
945 -
938 +\\
946 946  
947 947  (% class="western" %)
948 948  **COMPONENT: Products**
... ... @@ -1116,7 +1116,7 @@
1116 1116  Example:
1117 1117  
1118 1118  (% class="western" %)
1119 -{"Title":"Test123","Description": "Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1112 +{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1120 1120  )))
1121 1121  
1122 1122  (% class="wrapped" %)
... ... @@ -1174,7 +1174,7 @@
1174 1174  **Example**:
1175 1175  
1176 1176  (% class="western" %)
1177 -{"Title":"Test123","Description": "Testss","PrimaryFormId":10,"ResourceID":17}
1170 +{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1178 1178  )))
1179 1179  
1180 1180  (% class="wrapped" %)
... ... @@ -1608,7 +1608,7 @@
1608 1608  resource details in json to be sent as post data. Id should not be set.
1609 1609  
1610 1610  (% class="western" %)
1611 -**Possible Request Params**: Name, Description, Type, Value, FreePass
1604 +**Possible Request Params**: Name, Description, Type, Value
1612 1612  
1613 1613  (% class="western" %)
1614 1614  **Example**:
... ... @@ -1615,15 +1615,6 @@
1615 1615  
1616 1616  (% class="western" %)
1617 1617  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1618 -
1619 -(% class="western" %)
1620 -{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
1621 -
1622 -(% class="western" %)
1623 -{"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”, "FreePass":1}
1624 -
1625 -(% class="western" %)
1626 -{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
1627 1627  )))
1628 1628  
1629 1629  (% class="wrapped" %)
... ... @@ -1672,25 +1672,16 @@
1672 1672  Resource
1673 1673  )))|(((
1674 1674  (% class="western" %)
1675 -Resource details to be updated injsonformat to be sent withrequest. Id property needs to be set to identify the resource to be updated.
1659 +Resource details to be updated in json format to be sent with request. Id property needs to be set to identify the resource to be updated.
1676 1676  
1677 1677  (% class="western" %)
1678 1678  
1679 1679  
1680 1680  (% class="western" %)
1681 -Examples:
1665 +Example:
1682 1682  
1683 1683  (% class="western" %)
1684 1684  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1685 -
1686 -(% class="western" %)
1687 -{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
1688 -
1689 -(% class="western" %)
1690 -{"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”,"FreePass":1}
1691 -
1692 -(% class="western" %)
1693 -{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
1694 1694  )))
1695 1695  
1696 1696  (% class="wrapped" %)
... ... @@ -2974,30 +2974,14 @@
2974 2974  )))|(((
2975 2975  (% class="western" %)
2976 2976  String
2977 -
2978 -(% class="western" %)
2979 -or
2980 -
2981 -(% class="western" %)
2982 -Array
2983 2983  )))|(((
2984 2984  (% class="western" %)
2985 -Value of Resource Type:
2954 +Value of Resource Type.
2986 2986  
2987 2987  (% class="western" %)
2988 -When requesting a resource (GET), you should expect a string if there is only one value. If there are multiple values, you should expect an array.
2957 +Example : if the Type sent is 3 then Value would be **/digital/**
2989 2989  
2990 2990  (% class="western" %)
2991 -For creating/updating a resource (POST/PUT), it is highly recommended to send an array - this will handle single and multiple value requests.
2992 -
2993 -(% class="western" %)
2994 -Example :
2995 -
2996 -(% class="western" %)
2997 -if the Type sent is 3 with one value then Value would be "**/digital/**" or **["/digital"/].** We recommend using the second approach of **["/digital"/].** **
2998 -**if the Type sent is 3 with two values then Value would be ["**/digital/**", "**/articles/**"]
2999 -
3000 -(% class="western" %)
3001 3001  For Function type resource leave it blank.
3002 3002  )))
3003 3003  |(((
... ... @@ -3008,18 +3008,8 @@
3008 3008  Int
3009 3009  )))|(((
3010 3010  (% class="western" %)
3011 -Default limit is 25 but if all the data needs to be pulled then pass limit=0.
2970 +Default limit is 25 but all the data needs to be pulled then pass limit=0.
3012 3012  )))
3013 -|(% colspan="1" %)(% colspan="1" %)
3014 -(((
3015 -FreePass
3016 -)))|(% colspan="1" %)(% colspan="1" %)
3017 -(((
3018 -Int
3019 -)))|(% colspan="1" %)(% colspan="1" %)
3020 -(((
3021 -Default value is 0. This parameter is used to provide access to protected content.
3022 -)))
3023 3023  
3024 3024  
3025 3025  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -23331811
1 +3539010
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/23331811/ONEcount API Documentation
1 +https://info.onecount.net//wiki/spaces/OD/pages/3539010/ONEcount API Documentation