Open Ag Data Alliance API documentation version v0.2

https://{rootUri}/v0.2

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

The MIT License (MIT)

Copyright (c) 2014 OADA

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

/resources

Explore and manage resources in the data storage.

get Returns a paginated collection of all resources owned by the currently authenticated user. The results can be limited by an optional query parameter filter. options **TODO**: Write method description post Uploads a new resource and returns the resulting document.

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

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

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 Returns the contents of the given resource. head Returns the headers for the given resource. options **TODO**: Write method description put Creates or Updates a resource with given resource id. delete Deletes the specified resource and its associated data. patch Patches a resource with given resource id.

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

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

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

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

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

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 Returns the raw resource data. options **TODO**: Write method description put Creates or Updates the raw resource data. delete **TODO**: Write method description patch Patches the raw resource data.

Returns the raw resource data.

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/data",
    "etag": "164d48c47dc179df4ae7370a30d5ad2ef5460db3",
    "totalYield": {
        "value": 5.6,
        "unit": "bushel"
    },
    "crs": {
        "type": "name",
        "properties": {
            "name": "urn:ogc:def:crs:OGC:1.3:CRS84"
        }
    },
    "type": "FeatureCollection",
    "bbox": [40.42426718029455, 40.42429718029455, -86.841822197086, -86.841852197086],
    "features": [{
        "type": "Feature",
        "geometery": {
            "type": "Point",
            "coordinates": [40.42426718029455, -86.841822197086]
        },
        "properties": {
            "yield": {
                "value": 1.2,
                "unit": "bushel"
            }
        }
    }, {
    "type": "Feature",
    "geometery": {
        "type": "Point",
        "coordinates": [40.42429718029455, -86.841852197086]
    },
    "properties": {
        "yield": {
            "value": 4.2,
            "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 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

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

Creates or Updates the raw resource 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

  • 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/data",
    "etag": "164d48c47dc179df4ae7370a30d5ad2ef5460db3",
    "totalYield": {
        "value": 5.6,
        "unit": "bushel"
    },
    "crs": {
        "type": "name",
        "properties": {
            "name": "urn:ogc:def:crs:OGC:1.3:CRS84"
        }
    },
    "type": "FeatureCollection",
    "bbox": [40.42426718029455, 40.42429718029455, -86.841822197086, -86.841852197086],
    "features": [{
        "type": "Feature",
        "geometery": {
            "type": "Point",
            "coordinates": [40.42426718029455, -86.841822197086]
        },
        "properties": {
            "yield": {
                "value": 1.2,
                "unit": "bushel"
            }
        }
    }, {
    "type": "Feature",
    "geometery": {
        "type": "Point",
        "coordinates": [40.42429718029455, -86.841852197086]
    },
    "properties": {
        "yield": {
            "value": 4.2,
            "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/data",
    "etag": "164d48c47dc179df4ae7370a30d5ad2ef5460db3",
    "totalYield": {
        "value": 5.6,
        "unit": "bushel"
    },
    "crs": {
        "type": "name",
        "properties": {
            "name": "urn:ogc:def:crs:OGC:1.3:CRS84"
        }
    },
    "type": "FeatureCollection",
    "bbox": [40.42426718029455, 40.42429718029455, -86.841822197086, -86.841852197086],
    "features": [{
        "type": "Feature",
        "geometery": {
            "type": "Point",
            "coordinates": [40.42426718029455, -86.841822197086]
        },
        "properties": {
            "yield": {
                "value": 1.2,
                "unit": "bushel"
            }
        }
    }, {
    "type": "Feature",
    "geometery": {
        "type": "Point",
        "coordinates": [40.42429718029455, -86.841852197086]
    },
    "properties": {
        "yield": {
            "value": 4.2,
            "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

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

Patches the raw resource 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

  • 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/data",
    "etag": "164d48c47dc179df4ae7370a30d5ad2ef5460db3",
    "totalYield": {
        "value": 5.6,
        "unit": "bushel"
    },
    "crs": {
        "type": "name",
        "properties": {
            "name": "urn:ogc:def:crs:OGC:1.3:CRS84"
        }
    },
    "type": "FeatureCollection",
    "bbox": [40.42426718029455, 40.42429718029455, -86.841822197086, -86.841852197086],
    "features": [{
        "type": "Feature",
        "geometery": {
            "type": "Point",
            "coordinates": [40.42426718029455, -86.841822197086]
        },
        "properties": {
            "yield": {
                "value": 1.2,
                "unit": "bushel"
            }
        }
    }, {
    "type": "Feature",
    "geometery": {
        "type": "Point",
        "coordinates": [40.42429718029455, -86.841852197086]
    },
    "properties": {
        "yield": {
            "value": 4.2,
            "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 Returns the value of the given key. head **TODO**: Write method description options **TODO**: Write method description put Updates or Creates a value under the given key. If the key already exists, the original value will be lost. If the file format stored in ../data has a URI mapping, e.g., JSON Pointer, XML XPath, etc., then {key} may be replaced with with any valid URI to access only the associated portion of the document. If the file format stored in ../data does not have a URI mapping, then {key} may not be used. post Adds a single or set of key-value pairs to the store. If the file format stored in ../data has a URI mapping, e.g., JSON Pointer, XML XPath, etc., then {key} may be replaced with with any valid URI to access only the associated portion of the document. If the file format stored in ../data does not have a URI mapping, then {key} may not be used. delete Deletes the given key and its value. If the file format stored in ../data has a URI mapping, e.g., JSON Pointer, XML XPath, etc., then {key} may be replaced with with any valid URI to access only the associated portion of the document. If the file format stored in ../data does not have a URI mapping, then {key} may not be used. patch Patches a value under the given key. If the file format stored in ../data has a URI mapping, e.g., JSON Pointer, XML XPath, etc., then {key} may be replaced with with any valid URI to access only the associated portion of the document. If the file format stored in ../data does not have a URI mapping, then {key} may not be used.

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

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

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

Updates or Creates a value under the given key. If the key already exists, the original value will be lost.

If the file format stored in ../data has a URI mapping, e.g., JSON Pointer, XML XPath, etc., then {key} may be replaced with with any valid URI to access only the associated portion of the document.

If the file format stored in ../data does not have a URI mapping, then {key} may not be used.

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 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

Adds a single or set of key-value pairs to the store.

If the file format stored in ../data has a URI mapping, e.g., JSON Pointer, XML XPath, etc., then {key} may be replaced with with any valid URI to access only the associated portion of the document.

If the file format stored in ../data does not have a URI mapping, then {key} may not be used.

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

Deletes the given key and its value.

If the file format stored in ../data has a URI mapping, e.g., JSON Pointer, XML XPath, etc., then {key} may be replaced with with any valid URI to access only the associated portion of the document.

If the file format stored in ../data does not have a URI mapping, then {key} may not be used.

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

Patches a value under the given key.

If the file format stored in ../data has a URI mapping, e.g., JSON Pointer, XML XPath, etc., then {key} may be replaced with with any valid URI to access only the associated portion of the document.

If the file format stored in ../data does not have a URI mapping, then {key} may not be used.

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 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 Returns the value of the given meta data key. head Returns the headers for the given resource's meta data. options **TODO**: Write method description put Creates or Updates the value of the given meta data key. delete **TODO**: Write method description patch Patches the value of the given meta data key.

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

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

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

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

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

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 Returns the value of the given key. head **TODO**: Write method description options **TODO**: Write method description put Updates or Creates a value under the given key. If the key already exists, the original value will be lost. post Adds a single or set of key-value pairs to the store. delete Deletes the given key and its value. patch Patch the metum with metumId = {metumId}

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

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

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

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

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

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 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 Returns a collection of resource formats that the given resource can be returned as. options **TODO**: Write method description

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

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 Returns a collection of changes to this resource and all of the resources in its tree of children. options **TODO**: Write method description

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

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 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. options **TODO**: Write method description post Adds a parent directory to the given directory.

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

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

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 **TODO**: Write method description options **TODO**: Write method description delete **TODO**: Write method description

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

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

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 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. options **TODO**: Write method description post Adds a child directory to the given directory.

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

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

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 Returns a document describing the given child. options **TODO**: Write method description delete **TODO**: Write method description

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

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

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 Returns a paginated collection of all permissions associated with the given directory. The results can be limited by an optional query parameter filter. options **TODO**: Write method description post Creates a permission for this resource.

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

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

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 Returns the permission document associated with the given permission id. options **TODO**: Write method description put Creates or Updates a permission document associated with the given permission id. delete **TODO**: Write method description patch Updates a permission document associated with the given permission id.

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

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

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

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

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 Returns a paginated collection of all syncs associated with the given resource. The results can be limited by an optional query parameter filter. options **TODO**: Write method description post Creates a sync for this resource.

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

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

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 Returns the sync document associated with the given resource/sync id. options **TODO**: Write method description put Creates or Updates a sync document associated with the given resources/syncn id. delete **TODO**: Write method description patch Updates a sync document associated with the given resource/sync id.

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

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

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

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

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 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. options **TODO**: Write method description post Adds a derivative to the given resource.

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

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

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 **TODO**: Write method description options **TODO**: Write method description delete **TODO**: Write method description

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

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

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

/changes

get Returns a collection of changes to all available resources. options **TODO**: Write method description

Returns a collection of changes to all available resources.

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

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 Returns a document describing a particular change. options **TODO**: Write method description

Returns a document describing a particular change.

URI Parameters

  • changeId: 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

Body

Type: application/json

Example: 
{
    "href": "https://api.openag.io/changes/vda33d4",
    "etag": "83xhaw87fay3ofcbnkljiufoa83u8932yodasdcy",
    "changeId": "vda33d4",
    "deleted": "false",
    "resource": {
        "href": "https://api.agcloud.com/resources/dxkf337"
    }
}

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

TODO: Write method description

URI Parameters

  • changeId: 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

/configurations

Explore and manage farm configuration data such as fields, machines, etc. Eventually this data will help directly query resources.

get Returns a paginated collection of all configurations for the currently authenticated user. The results can be limited by an optional query parameter filter. options **TODO**: Write method description post Creates one or more new keys.

Returns a paginated collection of all configurations 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

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

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 Returns the key resource. options **TODO**: Write method description put Creates or Updates the given configuration key delete Deletes the specified key. patch Updates the given key.

Returns the key resource.

URI Parameters

  • configurationKey: 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

TODO: Write method description

URI Parameters

  • configurationKey: 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

Creates or Updates the given configuration key

URI Parameters

  • configurationKey: 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

Deletes the specified key.

URI Parameters

  • configurationKey: 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

Updates the given key.

URI Parameters

  • configurationKey: 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 **TODO**: Write method description options **TODO**: Write method description

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

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 Get a list of users options **TODO**: Write method description post Add a new user

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

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

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 **TODO**: Write method description options **TODO**: Write method description put **TODO**: Write method description delete **TODO**: Write method description patch **TODO**: Write method description

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

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

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

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

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 Get a list of groups options **TODO**: Write method description post Add a new group

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

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

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 **TODO**: Write method description options **TODO**: Write method description put **TODO**: Write method description delete **TODO**: Write method description patch **TODO**: Write method description

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

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

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

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

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 Get a list of authorizations options **TODO**: Write method description post Add a new authorization

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

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

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 **TODO**: Write method description options **TODO**: Write method description put **TODO**: Write method description delete **TODO**: Write method description patch **TODO**: Write method description

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

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

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

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

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 **TODO**: Write method description options **TODO**: Write method description

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

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 **TODO**: Write method description options **TODO**: Write method description

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

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