|
1174 | 1174 | <li data-group="Files" data-name="getAssociationsByObject" class="">
|
1175 | 1175 | <a href="#api-Files-getAssociationsByObject">getAssociationsByObject</a>
|
1176 | 1176 | </li>
|
| 1177 | + <li data-group="Files" data-name="getAssociationsCount" class=""> |
| 1178 | + <a href="#api-Files-getAssociationsCount">getAssociationsCount</a> |
| 1179 | + </li> |
1177 | 1180 | <li data-group="Files" data-name="getFile" class="">
|
1178 | 1181 | <a href="#api-Files-getFile">getFile</a>
|
1179 | 1182 | </li>
|
@@ -1896,7 +1899,7 @@ <h1>getAssociationsByObject</h1>
|
1896 | 1899 | <div class="pull-right"></div>
|
1897 | 1900 | <div class="clearfix"></div>
|
1898 | 1901 | <p></p>
|
1899 |
| - <p class="marked">By passing in the appropriate options,</p> |
| 1902 | + <p class="marked">By passing in the appropriate options, you can retrieve an association</p> |
1900 | 1903 | <p></p>
|
1901 | 1904 | <br />
|
1902 | 1905 | <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/{ObjectId}</span></code></pre>
|
@@ -2007,6 +2010,132 @@ <h2>Parameters</h2>
|
2007 | 2010 | </div>
|
2008 | 2011 | </div>
|
2009 | 2012 | </td>
|
| 2013 | +</tr> |
| 2014 | + |
| 2015 | + </table> |
| 2016 | + </article> |
| 2017 | + </div> |
| 2018 | + <hr> |
| 2019 | + <div id="api-Files-getAssociationsCount"> |
| 2020 | + <article id="api-Files-getAssociationsCount-0" data-group="User" data-name="getAssociationsCount" data-version="0"> |
| 2021 | + <div class="pull-left"> |
| 2022 | + <h1>getAssociationsCount</h1> |
| 2023 | + <p>Retrieves a count of associations for a list of objects.</p> |
| 2024 | + </div> |
| 2025 | + <div class="pull-right"></div> |
| 2026 | + <div class="clearfix"></div> |
| 2027 | + <p></p> |
| 2028 | + <p class="marked">By passing in the appropriate options, you can retrieve the association count for objects</p> |
| 2029 | + <p></p> |
| 2030 | + <br /> |
| 2031 | + <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/Count</span></code></pre> |
| 2032 | + <p> |
| 2033 | + <h3>Usage and SDK Samples</h3> |
| 2034 | + </p> |
| 2035 | + <ul class="nav nav-tabs nav-tabs-examples"> |
| 2036 | + <!-- *****REPLACE***** comment out the other languages <li> --> |
| 2037 | + <li class=""><a href="#examples-Files-getAssociationsCount-0-php">PHP</a></li> |
| 2038 | + </ul> |
| 2039 | + <div class="tab-content"> |
| 2040 | + <!-- *****REPLACE***** comment out the other languages tab-pane --> |
| 2041 | + <div class="tab-pane" id="examples-Files-getAssociationsCount-0-php"> |
| 2042 | + <pre class="prettyprint"><code class="language-php"><?php |
| 2043 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 2044 | + |
| 2045 | +// Configure OAuth2 access token for authorization: OAuth2 |
| 2046 | +$config = XeroAPI\XeroPHP\Configuration::getDefaultConfiguration()->setAccessToken( 'YOUR_ACCESS_TOKEN' ); |
| 2047 | + |
| 2048 | +$apiInstance = new XeroAPI\XeroPHP\Api\FilesApi( |
| 2049 | + new GuzzleHttp\Client(), |
| 2050 | + $config |
| 2051 | +); |
| 2052 | +$xeroTenantId = "YOUR_XERO_TENANT_ID"; |
| 2053 | +$objectIds = array() |
| 2054 | + |
| 2055 | +try { |
| 2056 | + $result = $apiInstance->getAssociationsCount($xeroTenantId, $objectIds); |
| 2057 | +} catch (Exception $e) { |
| 2058 | + echo 'Exception when calling FilesApi->getAssociationsCount: ', $e->getMessage(), PHP_EOL; |
| 2059 | +} |
| 2060 | +?> |
| 2061 | +</code></pre> |
| 2062 | + </div> |
| 2063 | + </div> |
| 2064 | + <h2>Scopes</h2> |
| 2065 | + <table> |
| 2066 | + |
| 2067 | + <tr> |
| 2068 | + <td>files</td> |
| 2069 | + <td>Grant read-write access to files and folders</td> |
| 2070 | + </tr> |
| 2071 | + |
| 2072 | + <tr> |
| 2073 | + <td>files.read</td> |
| 2074 | + <td>Grant read-only access to files and folders</td> |
| 2075 | + </tr> |
| 2076 | + |
| 2077 | + </table> |
| 2078 | + <h2>Parameters</h2> |
| 2079 | + <div class="methodsubtabletitle">Header parameters</div> |
| 2080 | + <table id="methodsubtable"> |
| 2081 | + <tr> |
| 2082 | + <th width="150px">Name</th> |
| 2083 | + <th>Description</th> |
| 2084 | + </tr> |
| 2085 | + <tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td> |
| 2086 | +<td> |
| 2087 | + |
| 2088 | + |
| 2089 | + <div id="d2e199_getAssociationsCount_xeroTenantId"> |
| 2090 | + <div class="json-schema-view"> |
| 2091 | + <div class="primitive"> |
| 2092 | + <span class="type"> |
| 2093 | + String |
| 2094 | + </span> |
| 2095 | + |
| 2096 | + <div class="inner description marked"> |
| 2097 | +Xero identifier for Tenant |
| 2098 | + </div> |
| 2099 | + </div> |
| 2100 | + <div class="inner required"> |
| 2101 | + Required |
| 2102 | + </div> |
| 2103 | + </div> |
| 2104 | + </div> |
| 2105 | +</td> |
| 2106 | +</tr> |
| 2107 | + |
| 2108 | + </table> |
| 2109 | + <div class="methodsubtabletitle">Query parameters</div> |
| 2110 | + <table id="methodsubtable"> |
| 2111 | + <tr> |
| 2112 | + <th width="150px">Name</th> |
| 2113 | + <th>Description</th> |
| 2114 | + </tr> |
| 2115 | + <tr><td style="width:150px;">ObjectIds<span style="color:red;">*</span></td> |
| 2116 | +<td> |
| 2117 | + |
| 2118 | + |
| 2119 | + <div id="d2e199_getAssociationsCount_objectIds"> |
| 2120 | + <div class="json-schema-view"> |
| 2121 | + <div class="primitive"> |
| 2122 | + <span class="type"> |
| 2123 | + array[UUID] |
| 2124 | + </span> |
| 2125 | + <span class="format"> |
| 2126 | + (uuid) |
| 2127 | + </span> |
| 2128 | + |
| 2129 | + <div class="inner description marked"> |
| 2130 | +A comma-separated list of object ids |
| 2131 | + </div> |
| 2132 | + </div> |
| 2133 | + <div class="inner required"> |
| 2134 | + Required |
| 2135 | + </div> |
| 2136 | + </div> |
| 2137 | + </div> |
| 2138 | +</td> |
2010 | 2139 | </tr>
|
2011 | 2140 |
|
2012 | 2141 | </table>
|
|
0 commit comments