openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 86.3 kB

JSON

{"openapi":"3.0.0","servers":[{"url":"https://platform.climate.com/"}],"info":{"contact":{"email":"developer@climate.com","name":"Climate FieldView Support"},"description":"**Last Modified**: Wed Jan 4 12:47:29 UTC 2023\n\n\nAll endpoints are only accessible via HTTPS.\n\n* All API endpoints are located at `https://platform.climate.com` (e.g.\n`https://platform.climate.com/v4/fields`).\n\n* The authorization token endpoint is located at\n`https://api.climate.com/api/oauth/token`.\n\n## Troubleshooting\n\n`X-Http-Request-Id` response header will be returned on every call,\nsuccessful or not. If you experience an issue with our api and need\nto contact technical support, please supply the value of the `X-Http-Request-Id`\nheader along with an approximate time of when the request was made.\n\n## Request Limits\n\nWhen you’re onboarded to Climate’s API platform, your `x-api-key` is assigned a custom usage plan. Usage plans are unique to each partner and have the following key attributes: \n\n1. Throttling information\n * burstLimit: Maximum rate limit over a period ranging from 1 second to a few seconds\n * rateLimit: A steady-state rate limit\n\n2. Quota information\n * Limit: The maximum number of requests that can be made in a given month\n\nWhen the request rate threshold is exceeded, a `429` response code is returned. Optionally, the [`Retry-After`](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.37) header may be returned: \n\nFollowing are examples of rate limit errors:\n\n1. Rate limit exceeded:\n\n HTTP/1.1 429 \n Content-Type: application/json\n Content-Length: 32\n\n {\"message\":\"Too Many Requests\"}\n\n2. Quota exhausted:\n HTTP/1.1 429 \n Content-Type: application/json\n Content-Length: 29\n\n {\"message\":\"Limit Exceeded\"}\n\n## Pagination\n\nPagination is performed via headers. Any request which returns a `\"results\"`\narray may be paginated. The following figure shows how query results are laid out with\nX-Limit=4 and no filter applied.\n\n<img style=\"width:70%;height:auto;\" src=\"https://s3-us-west-2.amazonaws.com/climate-com/images/svg_upload_tests/paging.png\">\n\n* If there are no results, a response code of `304` will be returned.\n\n* If the response is the last set of results, a response code of `200` or\n`206` will be returned.\n\n* If there are more results, a response code of `206` will be returned.\n\n* If `X-Next-Token` is provided in the request headers but the token has\nexpired, a response code of `409` will be returned. This is only applicable\nfor some endpoints; see specific endpoint documentation below.\n\n#### X-Limit\n\nThe page size can be controlled with the `X-Limit` header. Valid values are\n`1-100` and defaults to `100`.\n\n#### X-Next-Token\n\nIf the results are paginated, a response header of `X-Next-Token` will be\nreturned. Use the associated value in the subsequent request (via the `X-Next-Token`\nrequest header) to retrieve the next page. The following sequence diagram shows how to\nuse `X-Next-Token` to fetch all the records.\n\n<img src=\"https://s3-us-west-2.amazonaws.com/climate-com/images/svg_upload_tests/x-next-token.svg\">\n\n\n## Chunked Uploads\n\nUploads larger than `5MiB` (`5242880 bytes`) must be done in `5MiB` chunks\n(with the exception of the final chunk). Each chunk request MUST contain a\n`Content-Range` header specifying the portion of the upload, and a `Content-Type`\nheader specifying binary content type (`application/octet-stream`). Range\nuploads must be contiguous. The maximum upload size is capped at `500MiB` (`524288000 bytes`).\n\n## Chunked Downloads\n\nDownloads larger than `5MiB` (`5242880 bytes`) must be done in `1-5MiB`\nchunks (with the exception of the final chunk, which may be less than `1MiB`).\nEach chunk request MUST contain a `Range` header specifying the requested portion of the download,\nand an `Accept` header specifying binary and json content types (`application/octet-stream,application/json`)\nor all content types (`*/*`).\n\n## Drivers\n\nIf you need drivers to process agronomic data, download the ADAPT plugin below. We only support the plugin in the Windows environment, minimum is Windows 7 SP1.\n\nFor asPlanted, asHarvested and asApplied data:\n* [ADAPT Plugin](https://dev.fieldview.com/drivers/ClimateADAPTPlugin_latest.exe)\n Release notes can be found [here](https://dev.fieldview.com/drivers/adapt-release-notes.txt).\n Download and use of the ADAPT plugin means that you agree to the EULA for use of the ADAPT plugin. \n Please review the [EULA](https://dev.fieldview.com/EULA/ADAPT%20Plugin%20EULA-06-19.pdf) (last updated on June 6th, 2019) before download and use of the ADAPT plugin.\n For more information, please refer to:\n * [ADAPT Resources](https://adaptframework.org/)\n * [ADAPT Overview](https://aggateway.atlassian.net/wiki/spaces/ADM/overview)\n * [ADAPT FAQ](https://aggateway.atlassian.net/wiki/spaces/ADM/pages/165942474/ADAPT+Frequently-Asked+Questions+FAQ)\n * [ADAPT Videos](https://adaptframework.org/adapt-videos/)\n\n## Sample Test Data\n\nSample agronomic data:\n* [asPlanted and asHarvested data](https://dev.fieldview.com/sample-agronomic-data/Planting_Harvesting_data_04_18_2018_21_46_18.zip)\n* [asApplied data set 1](https://dev.fieldview.com/sample-agronomic-data/as-applied-data1.zip)\n* [asApplied data set 2](https://dev.fieldview.com/sample-agronomic-data/as-applied-data2.zip)\n To upload the sample data to your account, please follow the instructions in this [link](https://support.climate.com/kt#/kA02A000000AaxzSAC/en_US).\n\nSample soil data:\n* [Sample soil data](https://dev.fieldview.com/sample-soil-data/soil-sample.xml)\n---\n","title":"Climate FieldView Platform APIs","version":"4.0.11","x-apisguru-categories":["open_data"],"x-origin":[{"format":"openapi","url":"https://dev.fieldview.com/openapi/platform.yaml","version":"3.0"}],"x-providerName":"climate.com"},"tags":[{"description":"Field Boundary data endpoints.","name":"Boundaries"},{"description":"Field data endpoints.","name":"Fields"},{"description":"General data upload endpoints.","name":"Uploads"},{"description":"General data export endpoints.","name":"Exports"},{"description":"General data retrieval endpoints.","name":"Layers"},{"description":"Resource Owner data endpoints.","name":"ResourceOwners"},{"description":"Farm organization data endpoints.","name":"FarmOrganizations"},{"description":"Operation data endpoints.","name":"Operations"}],"paths":{"/v4/boundaries":{"post":{"description":"Upload a **Boundary** entry by passing the geometry of the boundary. This will store the boundary but will not create field in Climate FieldView and will not link to an existing field in Climate FieldView.\nThis is restricted to callers with **boundaries:write** scope.\nTo upload a field boundary for field creation in Climate FieldView, please use **POST /v4/uploads**.","operationId":"uploadBoundary","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoundaryUpload"}}}},"responses":{"200":{"$ref":"#/components/responses/UploadBoundaryOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["boundaries:write"]}],"summary":"Upload a boundary","tags":["Boundaries"]}},"/v4/boundaries/query":{"post":{"description":"Retrieve multiple **Boundaries** (up to 10 per request).","operationId":"fetchBoundaries","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoundariesQuery"}}}},"responses":{"200":{"$ref":"#/components/responses/FetchBoundariesOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["fields:read"]}],"summary":"Retrieve Boundaries in batch","tags":["Boundaries"]}},"/v4/boundaries/{boundaryId}":{"get":{"description":"Retrieve a **Boundary** by ID.","operationId":"fetchBoundaryById","parameters":[{"$ref":"#/components/parameters/BoundaryId"}],"responses":{"200":{"$ref":"#/components/responses/FetchBoundaryByIdOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","fields:read"]}],"summary":"Retrieve a Boundary by ID","tags":["Boundaries"]}},"/v4/exports":{"post":{"description":"Step one in requesting a data product. The method will return an **Export** ID which the caller will use in subsequent `GET` requests.\nThe following `contentTypes` may be requested:\n * __application/vnd.climate.acrsi.geojson__ (Beta)\n Exports the planting activities accessible by the authenticated user and optionally filtered by resource owner\n as a [GeoJSON Feature Collection](https://tools.ietf.org/html/rfc7946#page-12).\n\n The export request definition must contain the following properties:\n * plantingStartDate\n * plantingEndDate\n * resourceOwnerId\n\n Requires `exports:read` and `plantingActivitySummary:read` scope.\n \n * __application/vnd.climate.harvest.geojson__\n Exports the harvesting activities accessible by the authenticated user and optionally filtered by resource owner\n as a [GeoJSON Feature Collection](https://tools.ietf.org/html/rfc7946#page-12).\n\n The export request definition must contain the following properties:\n * harvestStartDate\n * harvestEndDate\n * resourceOwnerId\n\n Requires `exports:read` and `plantingActivitySummary:read` scope.","operationId":"postExport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}}},"responses":{"201":{"$ref":"#/components/responses/PostExportOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["exports:read"]}],"summary":"Initiate a new export request.","tags":["Exports"]}},"/v4/exports/{exportId}/contents":{"get":{"description":"Downloads larger than `5MiB` (`5242880 bytes`) in size must be downloaded in chunks no larger than `5MiB` (`5242880 bytes`) and no smaller than `1MiB` (`1048576 bytes`). The last chunk could be less than `1MiB` (`1048576 bytes`).","operationId":"fetchExportContentsById","parameters":[{"$ref":"#/components/parameters/Accept"},{"$ref":"#/components/parameters/ExportId"},{"$ref":"#/components/parameters/Range"}],"responses":{"204":{"$ref":"#/components/responses/204"},"206":{"$ref":"#/components/responses/FetchExportContentsByIdPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/ReportConflict"},"410":{"$ref":"#/components/responses/ReportGone"},"416":{"$ref":"#/components/responses/416"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["exports:read"]}],"summary":"Retrieve the binary contents of a processed export request.","tags":["Exports"]}},"/v4/exports/{exportId}/status":{"get":{"description":"Check the status of an **Export** by ID.","operationId":"fetchExportStatusById","parameters":[{"$ref":"#/components/parameters/ExportId"}],"responses":{"200":{"$ref":"#/components/responses/FetchExportStatusByIdOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["exports:read"]}],"summary":"Retrieve the status of an Export.","tags":["Exports"]}},"/v4/farmOrganizations/{farmOrganizationType}/{farmOrganizationId}":{"get":{"description":"Retrieve a given **farm organization** by organization type and ID.","operationId":"fetchFarmOrganizationByTypeAndId","parameters":[{"$ref":"#/components/parameters/FarmOrganizationType"},{"$ref":"#/components/parameters/FarmOrganizationId"}],"responses":{"200":{"$ref":"#/components/responses/FetchFarmOrganizationByTypeAndIdOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["farmOrganizations:read"]}],"summary":"Retrieve a specific farm organization by organization type and ID","tags":["FarmOrganizations"]}},"/v4/fields":{"get":{"description":"Retrieve list of **Fields**. Filter the results by field name if the `fieldName` query parameter is specified.","operationId":"fetchFields","parameters":[{"$ref":"#/components/parameters/X-Next-Token"},{"$ref":"#/components/parameters/X-Limit"},{"$ref":"#/components/parameters/OptionalFieldNamePrefix"}],"responses":{"200":{"$ref":"#/components/responses/FetchFieldsOk"},"206":{"$ref":"#/components/responses/FetchFieldsPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","fields:read"]}],"summary":"Retrieve list of Fields","tags":["Fields"]}},"/v4/fields/all":{"get":{"description":"Retrieve all fields the authenticated user has access to, including fields shared with the authenticated user from other resource owners. Filter the results by field name if the `fieldName` query parameter is specified.\nA 409 will be returned if the X-Next-Token has expired. When receiving a 409, the client should discard the X-Next-Token, discard all currently persisted fields for the user, and re-fetch fields from /fields/all.","operationId":"fetchAllFields","parameters":[{"$ref":"#/components/parameters/X-Next-Token"},{"$ref":"#/components/parameters/X-Limit"},{"$ref":"#/components/parameters/OptionalFieldNamePrefix"}],"responses":{"200":{"$ref":"#/components/responses/FetchFieldsOk"},"206":{"$ref":"#/components/responses/FetchFieldsPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","fields:read"]}],"summary":"Retrieve list of all Fields the user has access to.","tags":["Fields"]}},"/v4/fields/{fieldId}":{"get":{"description":"Retrieve a given **Field** by ID.","operationId":"fetchFieldById","parameters":[{"$ref":"#/components/parameters/FieldId"}],"responses":{"200":{"$ref":"#/components/responses/FetchFieldByIdOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","fields:read"]}],"summary":"Retrieve a specific Field by ID","tags":["Fields"]}},"/v4/layers/asApplied":{"get":{"description":"Retrieve a list of application activities. The id in the response is used for GET /v4/layers/asApplied/{activityId}/contents.","parameters":[{"$ref":"#/components/parameters/Accept"},{"$ref":"#/components/parameters/X-Next-Token"},{"$ref":"#/components/parameters/X-Limit"},{"$ref":"#/components/parameters/OptionalResourceOwnerId"},{"$ref":"#/components/parameters/OccurredAfter"},{"$ref":"#/components/parameters/OccurredBefore"},{"$ref":"#/components/parameters/UpdatedAfter"}],"responses":{"200":{"$ref":"#/components/responses/FetchApplicationActivitiesOk"},"206":{"$ref":"#/components/responses/FetchApplicationActivitiesPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","asApplied:read"]}],"summary":"Retrieve a list of application activities","tags":["Layers"]}},"/v4/layers/asApplied/{activityId}/contents":{"get":{"description":"Retrieve an individual application activity by id. Ids are retrieved via the /layers/asApplied route. Downloads larger than `5MiB` (`5242880 bytes`) in size, must be downloaded in chunks no larger than `5MiB` (`5242880 bytes`) and no smaller than `1MiB` (`1048576 bytes`). The last chunk could be less than `1MiB` (`1048576 bytes`). The data is compressed using .zip format.","parameters":[{"$ref":"#/components/parameters/Accept"},{"$ref":"#/components/parameters/ApplicationActivityId"},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"$ref":"#/components/responses/FetchApplicationActivityOk"},"206":{"$ref":"#/components/responses/FetchApplicationActivityPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"416":{"$ref":"#/components/responses/416"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["asApplied:read"]}],"summary":"Retrieve the raw application activity","tags":["Layers"]}},"/v4/layers/asHarvested":{"get":{"description":"Retrieve a list of harvest activities. The id in the response is used for GET /v4/layers/asHarvested/{activityId}/contents.","parameters":[{"$ref":"#/components/parameters/Accept"},{"$ref":"#/components/parameters/X-Next-Token"},{"$ref":"#/components/parameters/X-Limit"},{"$ref":"#/components/parameters/OptionalResourceOwnerId"},{"$ref":"#/components/parameters/OccurredAfter"},{"$ref":"#/components/parameters/OccurredBefore"},{"$ref":"#/components/parameters/UpdatedAfter"}],"responses":{"200":{"$ref":"#/components/responses/FetchHarvestActivitiesOk"},"206":{"$ref":"#/components/responses/FetchHarvestActivitiesPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","asHarvested:read"]}],"summary":"Retrieve a list of harvest activities","tags":["Layers"]}},"/v4/layers/asHarvested/{activityId}/contents":{"get":{"description":"Retrieve an individual harvest activity by id. Ids are retrieved via the /layers/asHarvested route. Downloads larger than `5MiB` (`5242880 bytes`) in size, must be downloaded in chunks no larger than `5MiB` (`5242880 bytes`) and no smaller than `1MiB` (`1048576 bytes`). The last chunk could be less than `1MiB` (`1048576 bytes`). The data is compressed using .zip format.","parameters":[{"$ref":"#/components/parameters/Accept"},{"$ref":"#/components/parameters/HarvestActivityId"},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"$ref":"#/components/responses/FetchHarvestActivityOk"},"206":{"$ref":"#/components/responses/FetchHarvestActivityPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"416":{"$ref":"#/components/responses/416"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["asHarvested:read"]}],"summary":"Retrieve the raw harvest activity","tags":["Layers"]}},"/v4/layers/asPlanted":{"get":{"description":"Retrieve a list of planting activities. The id in the response is used for GET /v4/layers/asPlanted/{activityId}/contents.","parameters":[{"$ref":"#/components/parameters/Accept"},{"$ref":"#/components/parameters/X-Next-Token"},{"$ref":"#/components/parameters/X-Limit"},{"$ref":"#/components/parameters/OptionalResourceOwnerId"},{"$ref":"#/components/parameters/OccurredAfter"},{"$ref":"#/components/parameters/OccurredBefore"},{"$ref":"#/components/parameters/UpdatedAfter"}],"responses":{"200":{"$ref":"#/components/responses/FetchPlantingActivitiesOk"},"206":{"$ref":"#/components/responses/FetchPlantingActivitiesPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","asPlanted:read"]}],"summary":"Retrieve a list of planting activities","tags":["Layers"]}},"/v4/layers/asPlanted/{activityId}/contents":{"get":{"description":"Retrieve an individual planting activity by id. Ids are retrieved via the /layers/asPlanted route. Downloads larger than `5MiB` (`5242880 bytes`) in size, must be downloaded in chunks no larger than `5MiB` (`5242880 bytes`) and no smaller than `1MiB` (`1048576 bytes`). The last chunk could be less than `1MiB` (`1048576 bytes`). The data is compressed using .zip format.","parameters":[{"$ref":"#/components/parameters/Accept"},{"$ref":"#/components/parameters/PlantingActivityId"},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"$ref":"#/components/responses/FetchPlantingActivityOk"},"206":{"$ref":"#/components/responses/FetchPlantingActivityPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"416":{"$ref":"#/components/responses/416"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["asPlanted:read"]}],"summary":"Retrieve the raw planting activity","tags":["Layers"]}},"/v4/layers/scoutingObservations":{"get":{"description":"Retrieve a list of scouting observations created or updated by the user identified by the Authorization header.","parameters":[{"$ref":"#/components/parameters/X-Next-Token"},{"$ref":"#/components/parameters/X-Limit"},{"$ref":"#/components/parameters/OccurredAfter"},{"$ref":"#/components/parameters/OccurredBefore"}],"responses":{"200":{"$ref":"#/components/responses/FetchScoutingObservationsOk"},"206":{"$ref":"#/components/responses/FetchScoutingObservationsPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","scouting:read"]}],"summary":"Retrieve a list of scouting observations","tags":["Layers"]}},"/v4/layers/scoutingObservations/{scoutingObservationId}":{"get":{"description":"Retrieve an individual scouting observation by id. Ids are retrieved via the /layers/scoutingObservations route.","parameters":[{"$ref":"#/components/parameters/ScoutingObservationId"}],"responses":{"200":{"$ref":"#/components/responses/FetchScoutingObservationByIdOk"},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","scouting:read"]}],"summary":"Retrieve individual scouting observation","tags":["Layers"]}},"/v4/layers/scoutingObservations/{scoutingObservationId}/attachments":{"get":{"description":"Retrieve attachments associated with a given scouting observation. Photos added to scouting notes in the FieldView app are capped to 20MB, and we won’t store photos larger than that in a scouting note.","parameters":[{"$ref":"#/components/parameters/ScoutingObservationId"},{"$ref":"#/components/parameters/X-Next-Token"},{"$ref":"#/components/parameters/X-Limit"}],"responses":{"200":{"$ref":"#/components/responses/FetchScoutingObservationAttachmentsOk"},"206":{"$ref":"#/components/responses/FetchScoutingObservationAttachmentsPartial"},"304":{"$ref":"#/components/responses/304"},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","scouting:read"]}],"summary":"Retrieve attachments associated with a given scouting observation.","tags":["Layers"]}},"/v4/layers/scoutingObservations/{scoutingObservationId}/attachments/{attachmentId}/contents":{"get":{"description":"Photos added to scouting notes in the FieldView app are capped to `20MiB` (`20971520 bytes`), and we won’t store photos larger than that in a scouting note. Downloads larger than `5MiB` (`5242880 bytes`) in size, must be downloaded in chunks no larger than `5MiB` (`5242880 bytes`) and no smaller than `1MiB` (`1048576 bytes`). The last chunk could be less than `1MiB` (`1048576 bytes`).","parameters":[{"$ref":"#/components/parameters/Accept"},{"$ref":"#/components/parameters/ScoutingObservationId"},{"$ref":"#/components/parameters/ScoutingObservationAttachmentId"},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"$ref":"#/components/responses/FetchScoutingObservationAttachmentContentsOk"},"206":{"$ref":"#/components/responses/FetchScoutingObservationAttachmentContentsPartial"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"416":{"$ref":"#/components/responses/416"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","scouting:read"]}],"summary":"Retrieve the binary contents of a scouting observation’s attachment.","tags":["Layers"]}},"/v4/operations/all":{"get":{"description":"Retrieve the **operations** accessible to the authenticated user. Filter the results by resource owner if the `resourceOwnerId` query parameter is specified.","operationId":"fetchOperations","parameters":[{"$ref":"#/components/parameters/OptionalResourceOwnerIdList"}],"responses":{"200":{"$ref":"#/components/responses/FetchOperationsOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["operations:read"]}],"summary":"Retrieve the operations accessible to a a given user.","tags":["Operations"]}},"/v4/resourceOwners/{resourceOwnerId}":{"get":{"description":"Retrieve a resource owner for the given `resourceOwnerId`.","operationId":"getResourceOwner","parameters":[{"$ref":"#/components/parameters/ResourceOwnerId"}],"responses":{"200":{"$ref":"#/components/responses/FetchResourceOwnerOk"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","resourceOwners:read"]}],"summary":"Retrieve a resource owner by ID","tags":["ResourceOwners"]}},"/v4/uploads":{"post":{"description":"Step one in uploading a data product. The method will return an **Upload** ID which the caller will use in subsequent `PUT` requests.\nThe following `contentTypes` may be uploaded:\n <details><summary>__image/vnd.climate.thermal.geotiff__</summary>\n\n Allows for the upload of a thermal image. The image is a single band geotiff with 64 bit signed floating point values in degrees Celsius. The Coordinate Reference System (CRS) must be UTM with WGS84 datum.\n\n The following metadata entries are required to be embedded in the geotiff:\n * acquisitionStartDate - ISO8601 date\n * acquisitionEndDate - ISO8601 date\n * isCalibrated - boolean\n\n The following metadata entries are optional:\n * sourceId - uuid referencing the asset in the partner's system\n * fieldId - uuid referencing a field in the Climate system\n * boundaryId - uuid referencing a boundary in the Climate system\n * brandId - uuid referencing a partner's branding in the Climate system\n * name - name of the layer. The maximum number of characters that will be accepted as input is 20.\n\n Requires either imagery:write or platform scope.\n </details>\n <details><summary>__image/vnd.climate.ndvi.geotiff__</summary>\n\n Allows for the upload of a NDVI image. The image is a single band geotiff with 64 bit signed floating point values in the range of -1 to 1 inclusive. The Coordinate Reference System (CRS) must be UTM with WGS84 datum.\n\n The following metadata entries are required to be embedded in the geotiff:\n * acquisitionStartDate - ISO8601 date\n * acquisitionEndDate - ISO8601 date\n\n The following metadata entries are optional:\n * sourceId - uuid referencing the asset in the partner's system\n * fieldId - uuid referencing a field in the Climate system\n * boundaryId - uuid referencing a boundary in the Climate system\n * brandId - uuid referencing a partner's branding in the Climate system\n * name - name of the layer. The maximum number of characters that will be accepted as input is 20.\n\n Requires either imagery:write or platform scope.\n </details>\n <details><summary> __image/vnd.climate.rgb.geotiff__</summary>\n\n Allows for the upload of a true color image. The image is a multi band geotiff with 24-bit composite values. Each band is 8 bits with values in the range of 0 to 255. The Coordinate Reference System (CRS) must be UTM with WGS84 datum. The geotiff must contain 3 bands in the order Red, Green, Blue.\n\n The following metadata entries are required to be embedded in the geotiff:\n * acquisitionStartDate - ISO8601 date\n * acquisitionEndDate - ISO8601 date\n * isCalibrated - boolean\n\n The following metadata entries are optional:\n * sourceId - uuid referencing the asset in the partner's system\n * fieldId - uuid referencing a field in the Climate system\n * boundaryId - uuid referencing a boundary in the Climate system\n * brandId - uuid referencing a partner's branding in the Climate system\n * reflectanceComputeMethod - either TOA or GROUND\n * name - name of the layer. The maximum number of characters that will be accepted as input is 20.\n\n Requires either imagery:write or platform scope.\n </details>\n <details><summary> __image/vnd.climate.rgb-nir.geotiff__</summary>\n\n Allows for the upload of a Near Infrared (NIR) image. The Coordinate Reference System (CRS) must be UTM with WGS84 datum.\n\n The following metadata entries are required to be embedded in the geotiff:\n * acquisitionStartDate - ISO8601 date\n * acquisitionEndDate - ISO8601 date\n * isCalibrated - boolean\n\n The following metadata entries are optional:\n * sourceId - uuid referencing the asset in the partner's system\n * fieldId - uuid referencing a field in the Climate system\n * boundaryId - uuid referencing a boundary in the Climate system\n * brandId - uuid referencing a partner's branding in the Climate system\n * reflectanceComputeMethod - either TOA or GROUND\n * name - name of the layer. The maximum number of characters that will be accepted as input is 20.\n\n Requires either imagery:write or platform scope.\n </details>\n <details><summary>__image/vnd.climate.rgb-cir.geotiff__</summary>\n\n Allows for the upload of a Color Infrared (CIR) image. The Coordinate Reference System (CRS) must be UTM with WGS84 datum.\n\n The following metadata entries are required to be embedded in the geotiff:\n * acquisitionStartDate - ISO8601 date\n * acquisitionEndDate - ISO8601 date\n * isCalibrated - boolean\n\n The following metadata entries are optional:\n * sourceId - uuid referencing the asset in the partner's system\n * fieldId - uuid referencing a field in the Climate system\n * boundaryId - uuid referencing a boundary in the Climate system\n * brandId - uuid referencing a partner's branding in the Climate system\n * reflectanceComputeMethod - either TOA or GROUND\n * name - name of the layer. The maximum number of characters that will be accepted as input is 20.\n\n Requires either imagery:write or platform scope.\n </details>\n <details><summary> __application/vnd.climate.rx.planting.shp__</summary>\n\n Allows for the upload of a planting prescription in shapefile format. The upload must be an archive in the zip format. It should contain one and only one of each of the following file types:\n * .shp\n * .shx\n * .dbf\n\n All files with the above suffixes must have the same prefix, ie Back40.shp, Back40.shx and Back40.dbf.\n\n Requires either rx:write or platform scope.\n </details>\n <details><summary> __application/vnd.climate.prescription.zones.shp__</summary>\n\n Allows for the upload of a zones prescription in shapefile format. The upload must be an archive in the zip format. It should contain one and only one of each of the following file types:\n * .shp\n * .shx\n * .dbf\n\n All files with the above suffixes must have the same prefix, ie Back40.shp, Back40.shx and Back40.dbf.\n\n The following metadata entries are required:\n * fieldId - field identifier for prescription zones.\n \n Requires either rxZones:write or platform scope.\n </details>\n <details><summary> __application/vnd.climate.modus.xml__</summary>\n\n Allows for the upload of a soil sampling file in the modus 1.0 format with some restrictions. The upload must be a single xml file.\n\n The following elements are required to be present in the modus file.\n * EventCode - Max length of 64 bytes\n * EventDate - Must be in ISO8601\n * SoilSample - Has a maxOccurs of 20k\n * Depth - Has a maxOccurs of 50\n * LabName - Must be non-empty.\n * StartingDepth - 0 to 36 inclusive, default 0\n * EndingDepth - 1 - 36 inclusive, default 1\n * ColumnDepth\n * DepthUnit - must be inches\n * Geometry - point in wgs84\n \n Requires the soil:write scope.\n </details>\n <details><summary> __application/vnd.climate.stand-count.geojson__</summary>\n\n Allows for the upload of a valid [geojson feature collection](https://tools.ietf.org/html/rfc7946#section-3.3).\n\n Each feature in the collection must contain the following entry in its properties section:\n * StandPPA - A count of the number of plants per acre:\n\n Additionally, the type field of each feature's geometry field must be:\n * Point\n\n Requires `imagery:write` scope.\n </details>\n <details><summary> __application/vnd.climate.weed-count.geojson__</summary>\n\n Allows for the upload of a valid [geojson feature collection](https://tools.ietf.org/html/rfc7946#section-3.3).\n\n Each feature in the collection must contain the following entry in its properties section:\n * StandPPA - A count of the number of plants per acre:\n\n Additionally, the type field of each feature's geometry field must be:\n * Point\n\n Requires `imagery:write` scope.\n </details>\n <details><summary> __application/vnd.climate.as-applied.zip__</summary>\n\n Allows for the upload of a valid application data [supported formats](https://support.climate.com/kt#/kA02A000000DjvOSAS/en_US).\n\n The following metadata entries are required:\n * fileName - name of the file being uploaded.\n\n The following metadata entries are optional:\n * resourceOwner - the grower's account email, where dealer/partner wants to upload data. As a prerequisite the grower must share their operation with the dealer/partner.\n\n Requires `asApplied:write` scope.\n </details>\n <details><summary> __application/vnd.climate.as-planted.zip__</summary>\n\n Allows for the upload of a valid planting data [supported formats](https://support.climate.com/kt#/kA02A000000DjvOSAS/en_US).\n\n The following metadata entries are required:\n * fileName - name of the file being uploaded.\n\n The following metadata entries are optional:\n * resourceOwner - the grower's account email, where dealer/partner wants to upload data. As a prerequisite the grower must share their operation with the dealer/partner.\n\n Requires `asPlanted:write` scope.\n </details>\n <details><summary> __application/vnd.climate.as-harvested.zip__</summary>\n\n Allows for the upload of a valid harvest data [supported formats](https://support.climate.com/kt#/kA02A000000DjvOSAS/en_US).\n\n The following metadata entries are required:\n * fileName - name of the file being uploaded.\n\n The following metadata entries are optional:\n * resourceOwner - the grower's account email, where dealer/partner wants to upload data. As a prerequisite the grower must share their operation with the dealer/partner.\n\n Requires `asHarvested:write` scope.\n </details>","operationId":"postUpload","parameters":[{"$ref":"#/components/parameters/X-Recipient-Email"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}}},"responses":{"201":{"$ref":"#/components/responses/PostUploadOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","fields:write","imagery:write","rx:write","standCount:write","weedCount:write","asApplied:write","asPlanted:write","asHarvested:write"]}],"summary":"Initiate a new upload","tags":["Uploads"]}},"/v4/uploads/status/query":{"post":{"description":"Check the status of multiple **Uploads** (up to 100 per request).","operationId":"fetchUploadStatuses","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadStatusQuery"}}}},"responses":{"200":{"$ref":"#/components/responses/FetchUploadStatusesOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","fields:write","imagery:write","rx:write","asApplied:write","asPlanted:write","asHarvested:write"]}],"summary":"Retrieve Upload statuses in batch","tags":["Uploads"]}},"/v4/uploads/{uploadId}":{"put":{"description":"Send chunked data for an **Upload**.","operationId":"chunkedUpload","parameters":[{"$ref":"#/components/parameters/ContentRange"},{"$ref":"#/components/parameters/UploadId"},{"$ref":"#/components/parameters/BinaryContentType"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","fields:write","imagery:write","rx:write","soil:write","asApplied:write","asPlanted:write","asHarvested:write"]}],"summary":"Chunked upload of data","tags":["Uploads"]}},"/v4/uploads/{uploadId}/status":{"get":{"description":"Check the status of an **Upload** by ID.","operationId":"fetchUploadStatusById","parameters":[{"$ref":"#/components/parameters/UploadId"}],"responses":{"200":{"$ref":"#/components/responses/FetchUploadStatusByIdOk"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"api_key":[]},{"oauth2_authorization_code":["platform","fields:write","imagery:write","rx:write","asApplied:write","asPlanted:write","asHarvested:write"]}],"summary":"Retrieve Upload status","tags":["Uploads"]}}},"components":{"parameters":{"Accept":{"description":"Must be either \\*/* or application/octet-stream,application/json","in":"header","name":"Accept","required":true,"schema":{"type":"string"}},"ApplicationActivityId":{"description":"Unique identifier of the Application Activity.","in":"path","name":"activityId","required":true,"schema":{"format":"uuid","type":"string"}},"BinaryContentType":{"description":"Must be `application/octet-stream`","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}},"BoundaryId":{"description":"Unique identifier of the Boundary","in":"path","name":"boundaryId","required":true,"schema":{"format":"uuid","type":"string"}},"ContentRange":{"description":"Byte range `bytes start-end/total` (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16). e.g. bytes 0-5242880/10242880. Downloads larger than 5MiB (5242880 bytes) in size must be downloaded in chunks no larger than 5MiB (5242880 bytes) and no smaller than 1MiB (1048576 bytes). The last chunk could be less than 1MiB (1048576 bytes).","in":"header","name":"Content-Range","required":true,"schema":{"type":"string"}},"ExportId":{"description":"Unique identifier of an Export.","in":"path","name":"exportId","required":true,"schema":{"format":"uuid","type":"string"}},"FarmOrganizationId":{"description":"Unique identifier of the farm organization.","in":"path","name":"farmOrganizationId","required":true,"schema":{"format":"uuid","type":"string"}},"FarmOrganizationType":{"description":"Type of the farm organization.","in":"path","name":"farmOrganizationType","required":true,"schema":{"enum":["farm"],"type":"string"}},"FieldId":{"description":"Unique identifier of the Field.","in":"path","name":"fieldId","required":true,"schema":{"format":"uuid","type":"string"}},"HarvestActivityId":{"description":"Unique identifier of the Harvest Activity.","in":"path","name":"activityId","required":true,"schema":{"format":"uuid","type":"string"}},"OccurredAfter":{"description":"Optional start time by which to filter layer results. Time must be in ISO 8601 format with time zone, e.g. 2016-05-13T00:00:00Z (https://tools.ietf.org/html/rfc3339). Layers with an end time at or after (inclusive) the specified time will match this filter. If both occurredAfter and occurredBefore are populated, occurredAfter must be <= occurredBefore.","in":"query","name":"occurredAfter","required":false,"schema":{"format":"date-time","type":"string"}},"OccurredBefore":{"description":"Optional end time by which to filter layer results. Time must be in ISO 8601 format with time zone, e.g. 2016-05-13T00:00:00Z (https://tools.ietf.org/html/rfc3339). Layers with a start time at or before (inclusive) the specified time. If both occurredAfter and occurredBefore are populated, occurredAfter must be <= occurredBefore.","in":"query","name":"occurredBefore","required":false,"schema":{"format":"date-time","type":"string"}},"OptionalFieldNamePrefix":{"description":"Optional prefix filter for field name. Must be at least 3 characters.","in":"query","name":"fieldName","required":false,"schema":{"type":"string"}},"OptionalResourceOwnerId":{"description":"Optional unique identifier of the resource owner. If resourceOwnerId is not specified, it defaults to the x-authenticated-user-uuid.","in":"query","name":"resourceOwnerId","required":false,"schema":{"format":"uuid","type":"string"}},"OptionalResourceOwnerIdList":{"description":"Optional comma-separated list of resource owner unique identifiers by which to filter results.","in":"query","name":"resourceOwnerId","required":false,"schema":{"type":"string"}},"PlantingActivityId":{"description":"Unique identifier of the Planting Activity.","in":"path","name":"activityId","required":true,"schema":{"format":"uuid","type":"string"}},"Range":{"description":"Byte range `bytes=start-end` (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.1). e.g. bytes=0-1048576. Currently only single range value is supported. Both start and end need to be specified, end value should be greater than start and end - start should not be greater than 5MiB.","in":"header","name":"Range","required":true,"schema":{"type":"string"}},"ResourceOwnerId":{"description":"Unique identifier of the resource owner.","in":"path","name":"resourceOwnerId","required":true,"schema":{"format":"uuid","type":"string"}},"ScoutingObservationAttachmentId":{"description":"Unique identifier of the attachment.","in":"path","name":"attachmentId","required":true,"schema":{"format":"uuid","type":"string"}},"ScoutingObservationId":{"description":"Unique identifier of the Scouting Observation.","in":"path","name":"scoutingObservationId","required":true,"schema":{"format":"uuid","type":"string"}},"UpdatedAfter":{"description":"Optional updated time by which to filter layer results. Time must be in ISO 8601 format with time zone, e.g. 2016-05-13T00:00:00Z (https://tools.ietf.org/html/rfc3339). Layers with a modification time at or after (inclusive) the specified time.","in":"query","name":"updatedAfter","required":false,"schema":{"format":"date-time","type":"string"}},"UploadId":{"description":"Unique identifier of an Upload.","in":"path","name":"uploadId","required":true,"schema":{"format":"uuid","type":"string"}},"X-Limit":{"description":"Max number of results to return per batch. Must be between 1 and 100 inclusive. Defaults to 100.","in":"header","name":"X-Limit","required":false,"schema":{"format":"int32","maximum":100,"minimum":1,"type":"integer"}},"X-Next-Token":{"description":"Opaque string which allows for fetching the next batch of results. Can be used to poll for changes.","in":"header","name":"X-Next-Token","required":false,"schema":{"type":"string"}},"X-Recipient-Email":{"description":"Email address associated with a Climate account, used when to sending to another user.","in":"header","name":"X-Recipient-Email","required":false,"schema":{"type":"string"}}},"responses":{"200":{"description":"OK","headers":{"X-Http-Request-Id":{"description":"Unique identifier assigned to the request.","schema":{"type":"string"}}}},"204":{"description":"No Content","headers":{"X-Http-Request-Id":{"description":"Unique identifier assigned to the request.","schema":{"type":"string"}}}},"304":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}},"description":"Not Modified","headers":{"X-Http-Request-Id":{"description":"Unique identifier assigned to the request.","schema":{"type":"string"}},"X-Next-Token":{"description":"A token which may be used to poll for updates.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Input","headers":{"X-Http-Request-Id":{"description":"Unique identifier assigned to the request.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized","headers":{"X-Http-Request-Id":{"description":"Unique identifier assigned to the request.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden","headers":{"X-Http-Request-Id":{"description":"Unique identifier assigned to the request.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found","headers":{"X-Http-Request-Id":{"description":"Unique identifier assigned to the request.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Conflict","headers":{"X-Http-Request-Id":{"description":"Unique identifier assigned to the request.","schema":{"type":"string"}}}},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Gone","headers":{"X-Http-Request-Id":{"description":"Unique identifier assigned to the request.","schema":{"type":"string"}}}},"416":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Range Not Satisfiable","headers":{"X-Http-Request-Id":{"description":"Unique identifier assi