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

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Admin
1 +XWiki.ayush
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 updated 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 update 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 resources
12 +**GET** - Used for lookup of resourcesresources
13 13  )))
14 14  1. (((
15 15  (% class="western" %)
... ... @@ -249,6 +249,7 @@
249 249  
250 250  
251 251  
252 +(% class="wrapped" %)
252 252  |(((
253 253  (% class="western" %)
254 254  **Method**
... ... @@ -368,6 +368,7 @@
368 368  (% class="western" %)
369 369  **GET method should be used to lookup users.**
370 370  
372 +(% class="wrapped" %)
371 371  |(((
372 372  (% class="western" %)
373 373  **Request**
... ... @@ -399,6 +399,7 @@
399 399  
400 400  
401 401  
404 +(% class="wrapped" %)
402 402  |(((
403 403  (% class="western" %)
404 404  **Response**
... ... @@ -425,6 +425,7 @@
425 425  (% class="western" %)
426 426  **POST method should be used to create users.**
427 427  
431 +(% class="wrapped" %)
428 428  |(((
429 429  (% class="western" %)
430 430  **Request**
... ... @@ -476,6 +476,7 @@
476 476  CSV of ONEcount QuestionId's requested back in Users object in response.
477 477  )))
478 478  
483 +(% class="wrapped" %)
479 479  |(((
480 480  (% class="western" %)
481 481  **Response**
... ... @@ -502,6 +502,7 @@
502 502  (% class="western" %)
503 503  **PUT method should be used to update users.**
504 504  
510 +(% class="wrapped" %)
505 505  |(((
506 506  (% class="western" %)
507 507  **Request**
... ... @@ -543,6 +543,7 @@
543 543  RequestDate to use for the demo update. If not provided current date will be used.
544 544  )))
545 545  
552 +(% class="wrapped" %)
546 546  |(((
547 547  (% class="western" %)
548 548  **Response**
... ... @@ -935,7 +935,7 @@
935 935  }
936 936  
937 937  (% class="western" %)
938 -\\
945 +
939 939  
940 940  (% class="western" %)
941 941  **COMPONENT: Products**
... ... @@ -1109,7 +1109,7 @@
1109 1109  Example:
1110 1110  
1111 1111  (% class="western" %)
1112 -{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1119 +{"Title":"Test123","Description": "Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1113 1113  )))
1114 1114  
1115 1115  (% class="wrapped" %)
... ... @@ -1167,7 +1167,7 @@
1167 1167  **Example**:
1168 1168  
1169 1169  (% class="western" %)
1170 -{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1177 +{"Title":"Test123","Description": "Testss","PrimaryFormId":10,"ResourceID":17}
1171 1171  )))
1172 1172  
1173 1173  (% class="wrapped" %)
... ... @@ -1601,7 +1601,7 @@
1601 1601  resource details in json to be sent as post data. Id should not be set.
1602 1602  
1603 1603  (% class="western" %)
1604 -**Possible Request Params**: Name, Description, Type, Value
1611 +**Possible Request Params**: Name, Description, Type, Value, FreePass
1605 1605  
1606 1606  (% class="western" %)
1607 1607  **Example**:
... ... @@ -1608,6 +1608,15 @@
1608 1608  
1609 1609  (% class="western" %)
1610 1610  {"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}
1611 1611  )))
1612 1612  
1613 1613  (% class="wrapped" %)
... ... @@ -1656,16 +1656,25 @@
1656 1656  Resource
1657 1657  )))|(((
1658 1658  (% class="western" %)
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.
1675 +Resource details to be updated injsonformat to be sent withrequest. Id property needs to be set to identify the resource to be updated.
1660 1660  
1661 1661  (% class="western" %)
1662 1662  
1663 1663  
1664 1664  (% class="western" %)
1665 -Example:
1681 +Examples:
1666 1666  
1667 1667  (% class="western" %)
1668 1668  {"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}
1669 1669  )))
1670 1670  
1671 1671  (% class="wrapped" %)
... ... @@ -2949,14 +2949,30 @@
2949 2949  )))|(((
2950 2950  (% class="western" %)
2951 2951  String
2977 +
2978 +(% class="western" %)
2979 +or
2980 +
2981 +(% class="western" %)
2982 +Array
2952 2952  )))|(((
2953 2953  (% class="western" %)
2954 -Value of Resource Type.
2985 +Value of Resource Type:
2955 2955  
2956 2956  (% class="western" %)
2957 -Example : if the Type sent is 3 then Value would be **/digital/**
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.
2958 2958  
2959 2959  (% 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" %)
2960 2960  For Function type resource leave it blank.
2961 2961  )))
2962 2962  |(((
... ... @@ -2969,6 +2969,16 @@
2969 2969  (% class="western" %)
2970 2970  Default limit is 25 but all the data needs to be pulled then pass limit=0.
2971 2971  )))
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 +)))
2972 2972  
2973 2973  
2974 2974  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3539010
1 +4882495
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/3539010/ONEcount API Documentation
1 +https://info.onecount.net//wiki/spaces/OD/pages/4882495/ONEcount API Documentation