Open Ag Data Alliance API documentation version v0.3
https://{rootUri}/v0.3
Overview
The OADA API is intended to serve as a specification for all providers that desire to be OADA compliant. This API does not attempt to define or enforce a single industry data standard. The goal of this API is to enable interoperability between the many precision ag software systems and existing industry data types. By providing an extensible API that focuses on information exchange and facilitates data transformations, an open heterogeneous environment that supports many legacy, current, and future data formats can be embraced.
Readme
OADA API Specification
The OADA API is intended to serve as a specification for all providers that desire to be OADA compliant. This API does not attempt to define or enforce a single industry data standard. The goal of this API is to enable interoperability between the many precision ag software systems and existing industry data types. By providing an extensible API that focuses on information exchange and facilitates data transformations an open heterogeneous environment that supports many legacy, current, and future data formats can be embraced.
About
For complete details on the OADA REST API, please see this oada-wiki entry. If you are intrested in more information about the whole OADA project, please peruse the project wiki here
License
OADA is openly developed and built under the MIT License.
Current Version
The current version of the OADA API specification is intended to be a draft revision to seek input and feedback from the larger precision ag community.
The draft specification has been defined in the RESTful API Modeling Language (RAML). The draft API specification in its entirety can be found here: oada-api.raml
To improve the readability of the specification it rendered into HTML by raml2html (developed by kevinrenskers/raml2html) from time to time:
Help us make it better
Please tell us how we can make the API better. If you have a specific feature request or if you found a bug, please use GitHub issues. Fork these docs and send a pull request with improvements. Join the oada-dev mailing list.
License
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
/resources
Explore and manage resources in the data storage.
get /resources
Returns a paginated collection of all resources owned by the currently authenticated user. The results can be limited by an optional query parameter filter.
Query Parameters
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10 -
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources",
"etag": "ajfds9fx898af3kjkfcajlkdcja98348912jkj90",
"items": [{
"href": "https://api.openag.io/resources/ixm24ws"
},
{
"href": "https://api.openag.io/resources/adfj92x"
},
{
"href": "https://api.openag.io/resources/x0923ak"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /resources
Uploads a new resource and returns the resulting document.
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
derivativeOf
(string)
Optional parameter. If included it must be a valid href to the resource of which the data is a derivative of. The OADA implementation will automatically add the new resource to the referenced resources derivative list.
Example:
https://openag.io/resources/d3jcds9
Body
Type: multipart/form-data
Form Parameters-
blob
required
(file)
The data blob to be uploaded.
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}
Returns the contents of the given resource.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Accept-Patch: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws",
"etag": "d3fc9278c677bdb7af3781a1ebc2ec090c14f5f3",
"guid": "https://api.openag.io/resources/ixm24ws",
"changeId": "xj3jdc5",
"name": "Frank's Yield",
"mimeType": "application/vnd.oada.yield+json",
"created": "1985-04-12T23:20:50.52Z",
"createdBy": {
"href": "https://api.openag.io/users/kdufe3f"
},
"modified": "1985-04-12T23:20:50.52Z",
"modifiedBy": {
"href": "https://api.openag.io/users/kdufe3f"
},
"data": {
"href": "https://api.openag.io/resources/ixm24ws/data"
},
"meta": {
"href": "https://api.openag.io/resources/ixm24ws/metadata"
},
"format": {
"href": "https://api.openag.io/resources/ixm24ws/format"
},
"parents": {
"href": "https://api.openag.io/resources/ixm24ws/parents"
},
"children": {
"href": "https://api.openag.io/resources/ixm24ws/children"
},
"permissions": {
"href": "https://api.openag.io/resources/ixm24ws/permissions"
},
"derivatives": {
"href": "https://api.openag.io/resources/ixm24ws/derivatives"
},
"sync": {
"href": "https://api.openag.io/resources/ixm24ws/syncs"
}
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
head /resources/{resourceId}
Returns the headers for the given resource.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Accept-Patch: string
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
put /resources/{resourceId}
Creates or Updates a resource with given resource id.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
Body
Type: multipart/form-data
Form Parameters-
blob
required
(file)
The data blob to be uploaded.
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws",
"etag": "d3fc9278c677bdb7af3781a1ebc2ec090c14f5f3",
"guid": "https://api.openag.io/resources/ixm24ws",
"changeId": "xj3jdc5",
"name": "Frank's Yield",
"mimeType": "application/vnd.oada.yield+json",
"created": "1985-04-12T23:20:50.52Z",
"createdBy": {
"href": "https://api.openag.io/users/kdufe3f"
},
"modified": "1985-04-12T23:20:50.52Z",
"modifiedBy": {
"href": "https://api.openag.io/users/kdufe3f"
},
"data": {
"href": "https://api.openag.io/resources/ixm24ws/data"
},
"meta": {
"href": "https://api.openag.io/resources/ixm24ws/metadata"
},
"format": {
"href": "https://api.openag.io/resources/ixm24ws/format"
},
"parents": {
"href": "https://api.openag.io/resources/ixm24ws/parents"
},
"children": {
"href": "https://api.openag.io/resources/ixm24ws/children"
},
"permissions": {
"href": "https://api.openag.io/resources/ixm24ws/permissions"
},
"derivatives": {
"href": "https://api.openag.io/resources/ixm24ws/derivatives"
},
"sync": {
"href": "https://api.openag.io/resources/ixm24ws/syncs"
}
}
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 409
Conflict
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /resources/{resourceId}
Deletes the specified resource and its associated data.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
patch /resources/{resourceId}
Patches a resource with given resource id.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws",
"etag": "d3fc9278c677bdb7af3781a1ebc2ec090c14f5f3",
"guid": "https://api.openag.io/resources/ixm24ws",
"changeId": "xj3jdc5",
"name": "Frank's Yield",
"mimeType": "application/vnd.oada.yield+json",
"created": "1985-04-12T23:20:50.52Z",
"createdBy": {
"href": "https://api.openag.io/users/kdufe3f"
},
"modified": "1985-04-12T23:20:50.52Z",
"modifiedBy": {
"href": "https://api.openag.io/users/kdufe3f"
},
"data": {
"href": "https://api.openag.io/resources/ixm24ws/data"
},
"meta": {
"href": "https://api.openag.io/resources/ixm24ws/metadata"
},
"format": {
"href": "https://api.openag.io/resources/ixm24ws/format"
},
"parents": {
"href": "https://api.openag.io/resources/ixm24ws/parents"
},
"children": {
"href": "https://api.openag.io/resources/ixm24ws/children"
},
"permissions": {
"href": "https://api.openag.io/resources/ixm24ws/permissions"
},
"derivatives": {
"href": "https://api.openag.io/resources/ixm24ws/derivatives"
},
"sync": {
"href": "https://api.openag.io/resources/ixm24ws/syncs"
}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 406
Not Acceptable
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_id
Returns the id corresponding to this resource.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_id
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta
Returns the value of the given _meta data key.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Accept-Patch: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/metadata",
"etag": "9a9a02cb51185d3fe1a6d5546d2659f8108aa425",
"yeild": {
"value": 5.6,
"unit": "bushel"
}
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
head /resources/{resourceId}/_meta
Returns the headers for the given resource's _meta data.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Accept-Patch: string
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
put /resources/{resourceId}/_meta
Creates or Updates the value of the given _meta data key.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/metadata",
"etag": "9a9a02cb51185d3fe1a6d5546d2659f8108aa425",
"yeild": {
"value": 5.6,
"unit": "bushel"
}
}
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/metadata",
"etag": "9a9a02cb51185d3fe1a6d5546d2659f8108aa425",
"yeild": {
"value": 5.6,
"unit": "bushel"
}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 409
Conflict
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /resources/{resourceId}/_meta
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
patch /resources/{resourceId}/_meta
Patches the value of the given _meta data key.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/metadata",
"etag": "9a9a02cb51185d3fe1a6d5546d2659f8108aa425",
"yeild": {
"value": 5.6,
"unit": "bushel"
}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 406
Not Acceptable
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/{key}
Returns the value of the given key.
URI Parameters
- resourceId: string
- key: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Accept-Patch: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
head /resources/{resourceId}/_meta/{key}
TODO: Write method description
URI Parameters
- resourceId: string
- key: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/{key}
TODO: Write method description
URI Parameters
- resourceId: string
- key: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Accept-Patch: string
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
put /resources/{resourceId}/_meta/{key}
Updates or Creates a value under the given key. If the key already exists, the original value will be lost.
URI Parameters
- resourceId: string
- key: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
Body
Type: multipart/form-data
Form Parameters-
blob
required
(file)
The data blob to be uploaded.
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 409
Conflict
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /resources/{resourceId}/_meta/{key}
Adds a single or set of key-value pairs to the store.
URI Parameters
- resourceId: string
- key: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
Body
Type: application/json
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /resources/{resourceId}/_meta/{key}
Deletes the given key and its value.
URI Parameters
- resourceId: string
- key: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
patch /resources/{resourceId}/_meta/{key}
Patch the _metum with _metumId = {_metumId}
URI Parameters
- resourceId: string
- key: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 406
Not Acceptable
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/formats
Returns a collection of resource formats that the given resource can be returned as.
URI Parameters
- resourceId: string
Query Parameters
-
_expand
(boolean)
Expand all document href properties to their actual resource.
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10 -
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
Body
Type: application/json
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/format",
"etag": "9cd8484acac0f9d787c714b95e0f36d07e3ed0cf",
"transforms": {
"application/vnd.oada.yield+json": {
"lossy": false,
"name": "OADA GeoJson Yield Open Format",
"openFormat": true
},
"application/json": {
"lossy": false,
"name": "JavaScript Object Notation",
"openFormat": false
},
"application/netcdf": {
"lossy": false,
"name": "Network Common Data Form",
"openFormat": true
},
"application/shape": {
"lossy": false,
"name": "Esri Shapefile",
"openFromat": false
}
}
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/formats
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/changes
Returns a collection of changes to this resource and all of the resources in its tree of children.
URI Parameters
- resourceId: string
Query Parameters
-
_expand
(boolean)
Expand all document href properties to their actual resource.
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10 -
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
lastChangeId
(string)
Optional. If provided the returned list of changes starts with the change directly following the given id.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/changes",
"etag": "askjdhf823hasjdhl38ayf8a4tad8ycehr3krhf4",
"items": [{
"href": "https://api.openag.io/changes/vda33d4"
},
{
"href": "https://api.openag.io/changes/jft567d"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/changes
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/parents
Returns a paginated collection of all directories that are parents to the given directory. The results can be limited by an optional query parameter filter.
URI Parameters
- resourceId: string
Query Parameters
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10 -
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/parents",
"etag": "a05d0b270af8d480c4c8222243f0ab58ed0d2770",
"items": [{
"href": "https://api.openag.io/resources/ixm24ws/parents/me30fzp"
},
{
"href": "https://api.openag.io/resources/ixm24ws/parents/madfjjx"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/parents
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /resources/{resourceId}/_meta/parents
Adds a parent directory to the given directory.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
Body
Type: application/json
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/parents/me30fzp",
"etag": "lkju893uacilkschj8pj3o8iyc83uc897yf87r43",
"resource": {
"href": "https://api.openag.io/resources/me30fzp"
}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/parents/{parentId}
TODO: Write method description
URI Parameters
- resourceId: string
- parentId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/parents/me30fzp",
"etag": "lkju893uacilkschj8pj3o8iyc83uc897yf87r43",
"resource": {
"href": "https://api.openag.io/resources/me30fzp"
}
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/parents/{parentId}
TODO: Write method description
URI Parameters
- resourceId: string
- parentId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /resources/{resourceId}/_meta/parents/{parentId}
TODO: Write method description
URI Parameters
- resourceId: string
- parentId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/children
Returns a paginated collection of all directories that are children of the given directory. The results can be limited by an optional query parameter filter.
URI Parameters
- resourceId: string
Query Parameters
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10 -
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/children",
"etag": "fe5215584c850cc978bedaed0b91da2e36007389",
"items": [{
"href": "https://api.openag.io/resources/ixm24ws/children/kl3j93s"
},
{
"href": "https://api.openag.io/resources/ixm24ws/parents/op302xa"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/children
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /resources/{resourceId}/_meta/children
Adds a child directory to the given directory.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
Body
Type: application/json
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/children/kl3j93s",
"resource": {
"href": "https://api.openag.io/resources/kl3j93s"
}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/children/{childId}
Returns a document describing the given child.
URI Parameters
- resourceId: string
- childId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/children/kl3j93s",
"resource": {
"href": "https://api.openag.io/resources/kl3j93s"
}
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/children/{childId}
TODO: Write method description
URI Parameters
- resourceId: string
- childId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /resources/{resourceId}/_meta/children/{childId}
TODO: Write method description
URI Parameters
- resourceId: string
- childId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/permissions
Returns a paginated collection of all permissions associated with the given directory. The results can be limited by an optional query parameter filter.
URI Parameters
- resourceId: string
Query Parameters
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10 -
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/permissions",
"etag": "d099fcbe546c2282ceea48c21cd14aebf8b0c055",
"items": [{
"href": "https://api.openag.io/resources/ixm24ws/permissions/jfi30x9"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/permissions
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /resources/{resourceId}/_meta/permissions
Creates a permission for this resource.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/permissions/jfi30x9",
"etag": "akdsjfa93jadjskclaj934jfq93cudosjacadhf9",
"user": {
"href": "https://api.openag.io/users/idnmz83"
},
"type": "user/group/IdP/anyone",
"level": "owner/writer/reader"
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/permissions/{permissionId}
Returns the permission document associated with the given permission id.
URI Parameters
- resourceId: string
- permissionId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Accept-Patch: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/permissions/jfi30x9",
"etag": "akdsjfa93jadjskclaj934jfq93cudosjacadhf9",
"user": {
"href": "https://api.openag.io/users/idnmz83"
},
"type": "user/group/IdP/anyone",
"level": "owner/writer/reader"
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/permissions/{permissionId}
TODO: Write method description
URI Parameters
- resourceId: string
- permissionId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Accept-Patch: string
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
put /resources/{resourceId}/_meta/permissions/{permissionId}
Creates or Updates a permission document associated with the given permission id.
URI Parameters
- resourceId: string
- permissionId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/permissions/jfi30x9",
"etag": "akdsjfa93jadjskclaj934jfq93cudosjacadhf9",
"user": {
"href": "https://api.openag.io/users/idnmz83"
},
"type": "user/group/IdP/anyone",
"level": "owner/writer/reader"
}
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/permissions/jfi30x9",
"etag": "akdsjfa93jadjskclaj934jfq93cudosjacadhf9",
"user": {
"href": "https://api.openag.io/users/idnmz83"
},
"type": "user/group/IdP/anyone",
"level": "owner/writer/reader"
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 409
Conflict
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /resources/{resourceId}/_meta/permissions/{permissionId}
TODO: Write method description
URI Parameters
- resourceId: string
- permissionId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
patch /resources/{resourceId}/_meta/permissions/{permissionId}
Updates a permission document associated with the given permission id.
URI Parameters
- resourceId: string
- permissionId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/permissions/jfi30x9",
"etag": "akdsjfa93jadjskclaj934jfq93cudosjacadhf9",
"user": {
"href": "https://api.openag.io/users/idnmz83"
},
"type": "user/group/IdP/anyone",
"level": "owner/writer/reader"
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 406
Not Acceptable
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/syncs
Returns a paginated collection of all syncs associated with the given resource. The results can be limited by an optional query parameter filter.
URI Parameters
- resourceId: string
Query Parameters
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10 -
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/syncs",
"etag": "ajf9e23i7u7def89aydu3kjhdaouiyed8q32y9c7",
"items": [{
"href": "https://api.openag.io/resources/ixm24ws/syncs/2xf382s"
},
{
"href": "https://api.openag.io/resources/ixm24ws/syncs/j923dkx"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/syncs
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /resources/{resourceId}/_meta/syncs
Creates a sync for this resource.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/syncs/2xf382s",
"etag": "cjkawq8327r4ifhjuihdvfaewytr43kj5haief7a",
"type": "poll",
"url": "https://api.agcloud.com/resources/jdkx82d",
"headers": {
"X-Custom": "Custom Value"},
"lastChangeId": "kjex9a3",
"interval": 3600,
"authorization": {
"href": "https://api.openag.io/authorizations/8ackam3"
}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/syncs/{syncId}
Returns the sync document associated with the given resource/sync id.
URI Parameters
- resourceId: string
- syncId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Accept-Patch: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/syncs/2xf382s",
"etag": "cjkawq8327r4ifhjuihdvfaewytr43kj5haief7a",
"type": "push",
"url": "https://api.agcloud.com/resources/jdkx82d",
"headers": {
"X-Custom": "Custom Value"
},
"events": ["change"],
"authorization": {
"href": "https://api.openag.io/authorizations/8ackam3"
}
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/syncs/{syncId}
TODO: Write method description
URI Parameters
- resourceId: string
- syncId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Accept-Patch: string
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
put /resources/{resourceId}/_meta/syncs/{syncId}
Creates or Updates a sync document associated with the given resources/syncn id.
URI Parameters
- resourceId: string
- syncId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/syncs/2xf382s",
"etag": "cjkawq8327r4ifhjuihdvfaewytr43kj5haief7a",
"type": "poll",
"url": "https://api.agcloud.com/resources/jdkx82d",
"headers": {
"X-Custom": "Custom Value"},
"lastChangeId": "kjex9a3",
"interval": 3600,
"authorization": {
"href": "https://api.openag.io/authorizations/8ackam3"
}
}
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/syncs/2xf382s",
"etag": "cjkawq8327r4ifhjuihdvfaewytr43kj5haief7a",
"type": "push",
"url": "https://api.agcloud.com/resources/jdkx82d",
"headers": {
"X-Custom": "Custom Value"
},
"events": ["change"],
"authorization": {
"href": "https://api.openag.io/authorizations/8ackam3"
}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 409
Conflict
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /resources/{resourceId}/_meta/syncs/{syncId}
TODO: Write method description
URI Parameters
- resourceId: string
- syncId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
patch /resources/{resourceId}/_meta/syncs/{syncId}
Updates a sync document associated with the given resource/sync id.
URI Parameters
- resourceId: string
- syncId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/syncs/2xf382s",
"etag": "cjkawq8327r4ifhjuihdvfaewytr43kj5haief7a",
"type": "push",
"url": "https://api.agcloud.com/resources/jdkx82d",
"headers": {
"X-Custom": "Custom Value"
},
"events": ["change"],
"authorization": {
"href": "https://api.openag.io/authorizations/8ackam3"
}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 406
Not Acceptable
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/derivatives
Returns a paginated collection of all the resources that are derivatives to the given resource. The results can be limited by an optional query parameter filter.
URI Parameters
- resourceId: string
Query Parameters
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10 -
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/derivatives",
"etag": "3ojxdkjxkajxhjkahl3wcyzyg3t236xgcvaxag37",
"items": [{
"href": "https://api.openag.io/resources/ixm24ws/derivatives/29xjadh"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/derivatives
TODO: Write method description
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /resources/{resourceId}/_meta/derivatives
Adds a derivative to the given resource.
URI Parameters
- resourceId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
Body
Type: application/json
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/derivatives",
"etag": "kdjf93fsdklcjasfldafu9afoicjajh3ofay8y3x",
"items": [{
"contentType": "application/shape",
"resource": {
"href": "https://api.agcloud.com/resource/djx83sc"
}
}]
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /resources/{resourceId}/_meta/derivatives/{derivativeId}
TODO: Write method description
URI Parameters
- resourceId: string
- derivativeId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/resources/ixm24ws/derivatives",
"etag": "kdjf93fsdklcjasfldafu9afoicjajh3ofay8y3x",
"items": [{
"contentType": "application/shape",
"resource": {
"href": "https://api.agcloud.com/resource/djx83sc"
}
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /resources/{resourceId}/_meta/derivatives/{derivativeId}
TODO: Write method description
URI Parameters
- resourceId: string
- derivativeId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /resources/{resourceId}/_meta/derivatives/{derivativeId}
TODO: Write method description
URI Parameters
- resourceId: string
- derivativeId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
/bookmarks
Explore and manage farm bookmark data such as fields, machines, etc. Eventually this data will help directly query resources.
get /bookmarks
Returns a paginated collection of all bookmarks for the currently authenticated user. The results can be limited by an optional query parameter filter.
Query Parameters
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10 -
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/configs",
"etag": "uiekanckjna721hnxccf2qxj8c7ds567cfa3ra3f",
"items": [{
"href": "https://api.openag.io/configs/fields"
},
{
"href": "https://api.openag.io/configs/prescriptions"
}],
"resource": {}
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /bookmarks
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /bookmarks
Creates one or more new keys.
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
Body
Type: application/json
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/configs",
"etag": "uiekanckjna721hnxccf2qxj8c7ds567cfa3ra3f",
"items": [{
"href": "https://api.openag.io/configs/fields"
},
{
"href": "https://api.openag.io/configs/prescriptions"
}],
"resource": {}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /bookmarks/{bookmarkKey}
Returns the key resource.
URI Parameters
- bookmarkKey: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Accept-Patch: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/config/prescriptions/planting",
"etag": "jkx6yc3c7cja89434inc8ascfjdkasfjc8i7a37x",
"items": [],
"resource": {
"href": "https://api.openag.io/resources/fd8as8c"
}
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /bookmarks/{bookmarkKey}
TODO: Write method description
URI Parameters
- bookmarkKey: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Accept-Patch: string
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
put /bookmarks/{bookmarkKey}
Creates or Updates the given bookmark key
URI Parameters
- bookmarkKey: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
Body
Type: application/json
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/config/prescriptions/planting",
"etag": "jkx6yc3c7cja89434inc8ascfjdkasfjc8i7a37x",
"items": [],
"resource": {
"href": "https://api.openag.io/resources/fd8as8c"
}
}
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/config/prescriptions/planting",
"etag": "jkx6yc3c7cja89434inc8ascfjdkasfjc8i7a37x",
"items": [],
"resource": {
"href": "https://api.openag.io/resources/fd8as8c"
}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 409
Conflict
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /bookmarks/{bookmarkKey}
Deletes the specified key.
URI Parameters
- bookmarkKey: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
patch /bookmarks/{bookmarkKey}
Updates the given key.
URI Parameters
- bookmarkKey: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
Body
Type: application/json
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/config/prescriptions/planting",
"etag": "jkx6yc3c7cja89434inc8ascfjdkasfjc8i7a37x",
"items": [],
"resource": {
"href": "https://api.openag.io/resources/fd8as8c"
}
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 404
Not Found
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 406
Not Acceptable
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
/about
A document that describes the current user and session.
get /about
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/about",
"etag": "w7d723ncj3hc8y7c8d7aj3klhjc8ay7366r8326e",
"rootResource": {
"href": "https://api.openag.io/resources/jx9j3x8"
},
"currentUser": {
"href": "https://api.openag.io/users/kdufe3f"
}
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /about
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
/users
The list of all users known to the current user.
get /users
Get a list of users
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/users",
"etag": "9dafjk3jfjaakjce3jkcha8d7c3hcausc6783a7c",
"items": [{
"href": "https://api.openag.io/resources/kdufe3f"
},
{
"href": "https://api.openag.io/resources/idnmz83"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /users
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /users
Add a new user
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/users",
"etag": "9dafjk3jfjaakjce3jkcha8d7c3hcausc6783a7c",
"items": [{
"href": "https://api.openag.io/resources/kdufe3f"
},
{
"href": "https://api.openag.io/resources/idnmz83"
}]
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /users/{userId}
TODO: Write method description
URI Parameters
- userId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Accept-Patch: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/users/kdufe3f",
"etag": "askdfjai389ac89a83jfklvfjv9qu34rtkn4kndf",
"account": "frank@agidentity.com",
"name": "Frank Fellow",
"picture": {
"url": "http://www.gravatar.com/avatar/c7e1ee573fc6b0956a4455560d5839d9"
},
"email": "frank@agcloud.com"
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /users/{userId}
TODO: Write method description
URI Parameters
- userId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Accept-Patch: string
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
put /users/{userId}
TODO: Write method description
URI Parameters
- userId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/users/kdufe3f",
"etag": "askdfjai389ac89a83jfklvfjv9qu34rtkn4kndf",
"account": "frank@agidentity.com",
"name": "Frank Fellow",
"picture": {
"url": "http://www.gravatar.com/avatar/c7e1ee573fc6b0956a4455560d5839d9"
},
"email": "frank@agcloud.com"
}
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/users/kdufe3f",
"etag": "askdfjai389ac89a83jfklvfjv9qu34rtkn4kndf",
"account": "frank@agidentity.com",
"name": "Frank Fellow",
"picture": {
"url": "http://www.gravatar.com/avatar/c7e1ee573fc6b0956a4455560d5839d9"
},
"email": "frank@agcloud.com"
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 409
Conflict
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /users/{userId}
TODO: Write method description
URI Parameters
- userId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
patch /users/{userId}
TODO: Write method description
URI Parameters
- userId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/users/kdufe3f",
"etag": "askdfjai389ac89a83jfklvfjv9qu34rtkn4kndf",
"account": "frank@agidentity.com",
"name": "Frank Fellow",
"picture": {
"url": "http://www.gravatar.com/avatar/c7e1ee573fc6b0956a4455560d5839d9"
},
"email": "frank@agcloud.com"
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 406
Not Acceptable
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
/groups
The list of all groups defined by the current user.
get /groups
Get a list of groups
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/groups",
"etag": "a9sdfakcj3a9joe9fa4ejfidjvffs9i4jur9egsc",
"items": [{
"href": "https://api.openag.io/groups/jf72jsd"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /groups
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /groups
Add a new group
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/groups",
"etag": "a9sdfakcj3a9joe9fa4ejfidjvffs9i4jur9egsc",
"items": [{
"href": "https://api.openag.io/groups/jf72jsd"
}]
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /groups/{groupId}
TODO: Write method description
URI Parameters
- groupId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Accept-Patch: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/groups/jf72jsd",
"etag": "9320kAJca9aclidfjkadsfjoaifckljaa726472e",
"name": "Employees",
"members": [{
"href": "https://api.openag.io/users/kdufe3f"
},
{
"href": "https://api.openagi.io/users/3jkxi82"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /groups/{groupId}
TODO: Write method description
URI Parameters
- groupId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Accept-Patch: string
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
put /groups/{groupId}
TODO: Write method description
URI Parameters
- groupId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/groups/jf72jsd",
"etag": "9320kAJca9aclidfjkadsfjoaifckljaa726472e",
"name": "Employees",
"members": [{
"href": "https://api.openag.io/users/kdufe3f"
},
{
"href": "https://api.openagi.io/users/3jkxi82"
}]
}
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/groups/jf72jsd",
"etag": "9320kAJca9aclidfjkadsfjoaifckljaa726472e",
"name": "Employees",
"members": [{
"href": "https://api.openag.io/users/kdufe3f"
},
{
"href": "https://api.openagi.io/users/3jkxi82"
}]
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 409
Conflict
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /groups/{groupId}
TODO: Write method description
URI Parameters
- groupId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
patch /groups/{groupId}
TODO: Write method description
URI Parameters
- groupId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/groups/jf72jsd",
"etag": "9320kAJca9aclidfjkadsfjoaifckljaa726472e",
"name": "Employees",
"members": [{
"href": "https://api.openag.io/users/kdufe3f"
},
{
"href": "https://api.openagi.io/users/3jkxi82"
}]
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 406
Not Acceptable
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
/authorizations
The list of all active authorizations, e.g., tokens, for the current user.
get /authorizations
Get a list of authorizations
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag -
_expand
(boolean)
Expand all document href properties to their actual resource.
-
q
(string)
TODO: The exact format of search queries is still under development.
-
offset
(integer)
The collection index of the first item in this page.
Example:
20 -
limit
(integer)
The number of items from the collection in this page.
Example:
10
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/authorizations",
"etag": "a98afjdskjasouf39823jadiscp903djoicu738d",
"items": [{
"href": "https://api.openag.io/authorizations/8ackam3"
}]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 400
Bad Request
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /authorizations
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
post /authorizations
Add a new authorization
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/authorizations",
"etag": "a98afjdskjasouf39823jadiscp903djoicu738d",
"items": [{
"href": "https://api.openag.io/authorizations/8ackam3"
}]
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /authorizations/{authorizationId}
TODO: Write method description
URI Parameters
- authorizationId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Accept-Patch: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/authorizations/8ackam3",
"etag": "ckljae9ui3djac983cj90jdskljaur90a3u4eace",
"user": {
"href": "https://api.openag.io/users/fjf23cd"
},
"scope": "resources groups",
"created": "1985-04-12T23:20:50.52Z",
"modified": "1985-04-12T23:20:50.52Z",
"expires": "1985-05-12T23:20:50.52Z"
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /authorizations/{authorizationId}
TODO: Write method description
URI Parameters
- authorizationId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Accept-Patch: string
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
put /authorizations/{authorizationId}
TODO: Write method description
URI Parameters
- authorizationId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/authorizations/8ackam3",
"etag": "ckljae9ui3djac983cj90jdskljaur90a3u4eace",
"user": {
"href": "https://api.openag.io/users/fjf23cd"
},
"scope": "resources groups",
"created": "1985-04-12T23:20:50.52Z",
"modified": "1985-04-12T23:20:50.52Z",
"expires": "1985-05-12T23:20:50.52Z"
}
HTTP status code 201
Created
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/authorizations/8ackam3",
"etag": "ckljae9ui3djac983cj90jdskljaur90a3u4eace",
"user": {
"href": "https://api.openag.io/users/fjf23cd"
},
"scope": "resources groups",
"created": "1985-04-12T23:20:50.52Z",
"modified": "1985-04-12T23:20:50.52Z",
"expires": "1985-05-12T23:20:50.52Z"
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 409
Conflict
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
delete /authorizations/{authorizationId}
TODO: Write method description
URI Parameters
- authorizationId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 204
No Content
Headers
- Date: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
patch /authorizations/{authorizationId}
TODO: Write method description
URI Parameters
- authorizationId: string
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"href": "https://api.openag.io/authorizations/8ackam3",
"etag": "ckljae9ui3djac983cj90jdskljaur90a3u4eace",
"user": {
"href": "https://api.openag.io/users/fjf23cd"
},
"scope": "resources groups",
"created": "1985-04-12T23:20:50.52Z",
"modified": "1985-04-12T23:20:50.52Z",
"expires": "1985-05-12T23:20:50.52Z"
}
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 406
Not Acceptable
Headers
- Content-Encoding: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 411
Length Required
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 412
Precondition Failed
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 415
Unsupported Media Type
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
/.well-known
get /.well-known/oada-configuration
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"authorizationEndpoint": "http://id.openag.io/connect/authorize",
"tokenEndpoint": "http://api.openag.io/connect/token",
"OADABaseUri": "https://api.openag.io"
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /.well-known/oada-configuration
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
get /.well-known/openid-configuration
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42 -
_fields
(string)
A list of top level keys that are returned.
All keys are returned by default when the parameter is omitted.
No response is generated if parameter is set to an empty string.
Example:
href, etag
HTTP status code 200
OK
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-Length: integer
- Content-MD5: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
Body
Type: application/json
Example:{
"issuer": "https://api.openag.io",
"authorization_endpoint": "https://api.openag.io/connect/authorize",
"token_endpoint": "https://api.openag.io/connect/token",
"token_endpoint_auth_methods_supported": ["client_secret_basic", "private_key_jwt"],
"token_endpoint_auth_signing_alg_values_supported": ["RS256", "ES256"],
"userinfo_endpoint": "https://api.openag.io/connect/userinfo",
"check_session_iframe": "https://api.openag.io/connect/check_session",
"end_session_endpoint": "https://api.openag.io/connect/end_session",
"jwks_uri": "https://api.openag.io/jwks.json",
"registration_endpoint": "https://api.openag.io/connect/register",
"scopes_supported": ["openid", "resources", "groups", "config"],
"response_types_supported": ["code", "code id_token", "id_token", "token id_token"],
"acr_values_supported": ["urn:mace:incommon:iap:silver", "urn:mace:incommon:iap:bronze"],
"subject_types_supported": ["public", "pairwise"],
"userinfo_signing_alg_values_supported": ["RS256", "ES256", "HS256"],
"userinfo_encryption_alg_values_supported": ["RSA1_5", "A128KW"],
"userinfo_encryption_enc_values_supported": ["A128CBC-HS256", "A128GCM"],
"id_token_signing_alg_values_supported": ["RS256", "ES256", "HS256"],
"id_token_encryption_alg_values_supported": ["RSA1_5", "A128KW"],
"id_token_encryption_enc_values_supported": ["A128CBC-HS256", "A128GCM"],
"request_object_signing_alg_values_supported": ["none", "RS256", "ES256"],
"display_values_supported": ["page", "popup"],
"claim_types_supported": ["normal", "distributed"],
"claims_supported": ["sub", "iss", "auth_time", "acr", "name", "picture", "email", "account"],
"claims_parameter_supported": true,
"service_documentation": "http://api.openag.io/connect/service_documentation.html",
"ui_locales_supported": ["en-US"]
}
HTTP status code 206
Partial Content
Headers
- Content-Encoding: string
- Content-Disposition: string
- Content-MD5: string
- Content-Range: string
- Content-Type: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 304
Not Modified
Headers
- Date: string
- ETag: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 416
Requested Range Not Satisfiable
Headers
- Content-Range: string
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
options /.well-known/openid-configuration
TODO: Write method description
Query Parameters
-
access_token
(string)
OAuth 2.0 token. Prefer the Authorization header.
Example:
0b79bab50daca910b000d4f1a2b675d604257e42
HTTP status code 200
OK
Headers
- Allow: string
- Date: string
- ETag: string
- Expires: string
- Last-Modified: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 301
Moved Permanently
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 307
Temporary Redirect
Headers
- Expires: string
- Location: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 401
Unauthorized
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
- WWW-Authenticate: string
HTTP status code 403
Forbidden
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer
HTTP status code 429
Too Many Requests
Headers
- Expires: string
- X-Rate-Limit-Limit: integer
- X-Rate-Limit-Remaining: integer
- X-Rate-Limit-Reset: integer