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

Summary

Details

Page properties
Content
... ... @@ -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" %)
... ... @@ -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}
1119 +{"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","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1177 +{"Title":"Test123","Description": "Testss","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
1611 +**Possible Request Params**: Name, Description, Type, Value, FreePass
1612 1612  
1613 1613  (% class="western" %)
1614 1614  **Example**:
... ... @@ -1615,6 +1615,15 @@
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}
1618 1618  )))
1619 1619  
1620 1620  (% class="wrapped" %)
... ... @@ -1663,16 +1663,25 @@
1663 1663  Resource
1664 1664  )))|(((
1665 1665  (% class="western" %)
1666 -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.
1667 1667  
1668 1668  (% class="western" %)
1669 1669  
1670 1670  
1671 1671  (% class="western" %)
1672 -Example:
1681 +Examples:
1673 1673  
1674 1674  (% class="western" %)
1675 1675  {"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}
1676 1676  )))
1677 1677  
1678 1678  (% class="wrapped" %)
... ... @@ -2956,14 +2956,30 @@
2956 2956  )))|(((
2957 2957  (% class="western" %)
2958 2958  String
2977 +
2978 +(% class="western" %)
2979 +or
2980 +
2981 +(% class="western" %)
2982 +Array
2959 2959  )))|(((
2960 2960  (% class="western" %)
2961 -Value of Resource Type.
2985 +Value of Resource Type:
2962 2962  
2963 2963  (% class="western" %)
2964 -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.
2965 2965  
2966 2966  (% 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" %)
2967 2967  For Function type resource leave it blank.
2968 2968  )))
2969 2969  |(((
... ... @@ -2974,8 +2974,18 @@
2974 2974  Int
2975 2975  )))|(((
2976 2976  (% class="western" %)
2977 -Default limit is 25 but all the data needs to be pulled then pass limit=0.
3011 +Default limit is 25 but if all the data needs to be pulled then pass limit=0.
2978 2978  )))
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 +)))
2979 2979  
2980 2980  
2981 2981  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3539014
1 +23331811
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/3539014/ONEcount API Documentation
1 +https://info.onecount.net//wiki/spaces/OD/pages/23331811/ONEcount API Documentation