Base Logo
Documentation Powered by ReDoc

Syngenta Base Platform API (1.16.0)

Download OpenAPI specification:Download

Introduction

The Syngenta Base Platform offers common functionality for digital agriculture apps (such as OAuth-based Single Sign-On, properties, seasons, field records, etc). The Base API is built on HTTP and is mostly RESTful: It has predictable resource URLs, returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body.

Start developing

Contact Syngenta to obtain the following info needed to connect your app:

  • OAuth client_id and client_secret
  • URLs for sandbox and production API servers

Please note this API doc is not for wider circulation at this time.

This API is describe in OpenAPI 3.0 format. You can download the OpenAPI spec with the link at the top of the doc portal (or find it attached in the bundle sent to you).

With that, you can use your favorite HTTP/REST client to import the spec (use the Download link above or directly import https://docs.cropwise.com/api/alpha/openapi.yaml). There are also code generation tools for many programming languages.

Some notes:

  • Errors are generally developer-readable (though not generally user-readable) in API responses. Format is generally described by the BasicError or ErrorCollection models. Full error handling docs is in progress.
  • (For internal developers): the client ID for the main UI of the platform is strix-ui. That is, add the Authorization: Basic c3RyaXgtdWk6 header in access management endpoints which need the client ID to be identified.
  • Localized responses will make use of the Accept-Language header value. Examples: en, es, pt-BR

Concepts

General Concepts

Organization

An Organization is a master entity that has a set of properties. This entity groups and controls all the resources involved in the culture, for instance, different crops, seasons, etc.

Property

A property is the representation of a farm with a set of regions and fields.

Region

The platform has a system of hierarchical representation of geographical structures, composed of Fields and Regions. A region may contain fields or other regions. Regions work like trees: a region can be a root or a node - when it contains other child regions - or a leaf - when it is an actual field, defined by a specific geometry.

Field

A field is a specialization of a region. Fields are specifically identified as the leaf of the region tree. It is specifically the only entity which has an actual polygon that describes its size and position in the world.

Crop Cycle

What is a Crop Cycle?

The Crop Cycle is a generical entity responsible for grouping a list of fields with a crop assigned over time.

Crop Cycle Property

Crop Cycle Property is the association of a Crop Cycle to a property (or part of its fields). This way a property can have different cycles running at the same time, depending on the type of crops that are cultivated in this property.

Crop Cycle Field

Crop Cycle Field is a cycle defined to a field of a property. This way the property can have multiple cycles assigned depending on how many fields with different crops it has.

Season concept (legacy)

Season is a legacy concept of representing crop cycles, this name is still used inside the API for backward compatibility measures.

Field Geometry Updates

Basic concepts

The Cropwise platform has a system of hierarchical representation of geographical structures, composed of Field and Regions. A region may contain fields or other regions.

Structure

The geographic objects of API use the GeoJSON (RFC 7946) format. The regions and fields can be represented as GeoJSON Features with a specific property schema. The geometry field can optionally be specified as null when the Feature is a Region.

Each region or field is identified at a Property by a key, a unique client-provided string aliased by the structure FeatureID.

Their names and other properties are represented using the FeatureProperties schema. The hierarchy of regions and fields is established by using the parent_id field, which is used to specify an field or region as belonging to another field or region.

Update Requests

Regions and fields can be created, modified and deleted by a GeometryUpdateRequest, which is a resource representing the map update request operation with is payload and some additional operation-wide controls.

The FeatureProperties structure specifies the operation codes and allows conditional changes to avoid race conditions.

Versioning and Conditional Changes

Every version of a region is identified by a revision hash. To avoid race conditions, clients SHOULD use conditions on the regions, which makes the system perform the change only if the conditions are satisfied. Using Conditional Changes and strict mode is strongly recommended.

Rate Limiting and other limitations

This scope of the API can be called at most 100 times per hour, and request bodies are limited to 5 MB.

Catalog/Organization Catalog

Crop

A crop is something that can be grown and harvested extensively for profit or subsistence. E.g: Soybean, Cotton, Coffee.

  • Development Phase: Development phase represents the plant stage of growth. The classification of these stages can differ from crop to crop.

Product

A Product is an input that can be used in a property. Products could be Fungicides, Herbicides, Pesticides, Seeds and so on.

  • Variety: "Kind" is the term often used for the seed of one or more related plants known by a common name such as carrot, radish, wheat, or soybean. Variety is a subdivision of a kind. A variety has different characteristics from another variety of the same kind of seed.

Captcha

Some unauthenticated endpoints (singup, password recovery, etc) MAY refuse requests under some circumstances unless a CAPTCHA is provided. To provide a CAPTCHA, include the following field in the object root:

"_captcha": { "type": "recapcha", "token": "<issue reCaptcha token>" }

Error handling

Requests should return appropriate error codes (e.g. 400 for most request-caused errors) and a JSON object containing error details.

{
  "timestamp": "2019-02-27T04:21:17.740+0000",
  "status": 404,
  "error": "Not Found",
  "code": "EACC012",
  "message": "Account does not exist",
  "path": "/v2/accounts/34550190-7d4f-4a03-91ec-4f5568e50029"
}

Error codes

All error messages should be mapped with error codes.

These codes will be at this following format: E{3 character for context}{3 digit for indexing}.

Common errors

  • EARG001: Missing field on request body. This error will occur when a required field is not being set on the request body.
  • EIAM001: Account is not authorized to perform this operation. This error will occur when the user tries to perform an API operation without the required authorities to do so.
  • EINT001: Intenal server error. If this error shows up, please contact the support team. It's an unexpected error and it should not happen.

Authentication

SyngentaOAuth

For more information, see https://digitial-product-engineering.atlassian.net/wiki/x/YQHZvw

Security Scheme Type OAuth2
implict OAuth Flow
Scopes:
  • read -

    Read all resources

  • write -

    Write all resources

OAuth2

NOTE: OAuth URLs are relative to the server root and do not include the v2/ prefix.

Security Scheme Type OAuth2
password OAuth Flow
Token URL: /oauth/token
Refresh URL: /oauth/token
Scopes:
  • read -

    Read all resources

  • write -

    Write all resources

authorizationCode OAuth Flow
Authorization URL: /oauth/authorize
Token URL: /oauth/token
Refresh URL: /oauth/token
Scopes:
  • read -

    Read all resources

  • write -

    Write all resources

Access Management

Account and Permissions related operations

Account

Everything about accessing an Account

Get Account by name.

query Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get If Account exists.

query Parameters
login
required
string

Responses

Response samples

Content type
application/json
{
  • "response": true
}

update authorities

path Parameters
account_id
required
string
Request Body schema: application/json
required
Array of objects (A authority operation)

Responses

Request samples

Content type
application/json
{
  • "updates": [
    ]
}

Get Account's Roles

Return the roles of an account

path Parameters
account_id
required
string

Account ID.

query Parameters
last_key
string
size
integer

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "number_of_elements": 1,
  • "last": true,
  • "first": true,
  • "empty": false
}

Upload Account Photo

Uploads Account photo.

path Parameters
account_id
required
string
Request Body schema: multipart/form-data

Multipart Form including the icon file (png or jpg)

photo
string <binary>

Responses

Response samples

Content type
application/json
{}

Remove Account Photo

Removes the Account photo.

path Parameters
account_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Give SUPPORT Authority

Gives SUPPORT authority to a user.

Only super-users will be able to call this endpoint.

path Parameters
account_id
required
string

Responses

Remove SUPPORT Authority

Removes SUPPORT authority from a user.

Only super-users will be able to call this endpoint.

path Parameters
account_id
required
string

Responses

Get Account By Id

Retrieve an Account with the specified id.

path Parameters
account_id
required
string

Account ID.

query Parameters
include_extended
boolean
exclude_attributes
string

Attributes to exclude

internal_authorities
boolean

Include internal authorities

Responses

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "string",
  • "type": "string",
  • "role": "GROWER",
  • "ssn": "string",
  • "tutorial_complete": true,
  • "phone": "+5531900000000",
  • "authorities": [
    ],
  • "locale": "string",
  • "clock_format": "ALWAYS_12",
  • "pending_change_password": true,
  • "default_workspace_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "workspaces": [
    ],
  • "login": "string",
  • "country_code": "st",
  • "photo_uri": "string",
  • "email": "user@example.com",
  • "auto_created_org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Delete an Account

Delete the specified Account.

path Parameters
account_id
required
string

Account ID.

query Parameters
include_extended
boolean

Responses

Edit Account

Edits an existing Account with the specified id.

path Parameters
account_id
required
string

Account ID.

query Parameters
include_extended
boolean
Request Body schema: application/json
role
required
string (Account Role)
Enum: "GROWER" "MANAGER" "ADMIN" "DEALER" "CONSULTANT" "AGRONOMIST" "OTHER"
ssn
required
string
phone
required
string (Phone Number)

E.164 international phone number formatting

https://www.itu.int/rec/T-REC-E.164/en
Array of objects (Signup Opt In)
locale
string
country_code
string 2 characters
photo_uri
string
id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

name
required
string

Responses

Request samples

Content type
application/json
{
  • "role": "GROWER",
  • "ssn": "123456",
  • "phone": "+5531900000000",
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "Caiubi Oliveira Fonseca",
  • "locale": "en",
  • "country_code": "BR",
  • "photo_uri": "https://photo-uri.com",
  • "opt_ins": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "string",
  • "type": "string",
  • "role": "GROWER",
  • "ssn": "string",
  • "tutorial_complete": true,
  • "phone": "+5531900000000",
  • "authorities": [
    ],
  • "locale": "string",
  • "clock_format": "ALWAYS_12",
  • "pending_change_password": true,
  • "default_workspace_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "workspaces": [
    ],
  • "login": "string",
  • "country_code": "st",
  • "photo_uri": "string",
  • "email": "user@example.com",
  • "auto_created_org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Batch get account roles by ids

Return the roles of accounts

query Parameters
last_key
string
size
integer
Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "number_of_elements": 1,
  • "last": true,
  • "first": true,
  • "empty": false
}

Get Accounts by Ids

Get Accounts by its Ids. If an id does not exist, it does not return it.

query Parameters
attributes
Array of strings
Items Enum: "workspaces" "licensing_accounts"

Return the users' relantionship workspace-organization

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Revoke Sent Invitation

Revoke Sent Invitation

path Parameters
id
required
string

Responses

Get current user

Requests current signed user basic info, permissions and organizations.

query Parameters
exclude_attributes
string

Attributes to exclude

internal_authorities
boolean

Include internal authorities

Responses

Response samples

Content type
application/json
{
  • "name": "User",
  • "authorities": [
    ],
  • "type": "USER",
  • "ssn": null,
  • "role": null,
  • "phone": "+91 98765-4321",
  • "locale": "en",
  • "country_code": "BR",
  • "clock_format": "LET_LOCALE_DECIDE",
  • "login": "user@email.com",
  • "email": "user@email.com",
  • "auto_created_org_id": "384f0b5f-25a5-4102-85ca-7c4fa43a7832",
  • "opt_ins": [
    ],
  • "id": "c8f6a433-a8a2-481d-83c9-c2ee29681f6b",
  • "default_licensing_account_id": "ed2031da-94eb-4892-9f76-f41cd993c8be",
  • "default_workspace_id": "ed2031da-94eb-4892-9f76-f41cd993c8be"
}

Translate Roles to Legacy permissions

To the given user, it translates the provided Role to Legacy permissions, it can be done synchronously or asynchronously.

path Parameters
account_id
required
string

Account ID.

query Parameters
run_async
boolean

Run process asynchronously

Request Body schema: application/json
operation
string
Enum: "add" "remove"
role_id
string
workspace_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

organization_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

property_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

app_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

account_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Request samples

Content type
application/json
{
  • "role_id": "A role",
  • "operation": "add",
  • "workspace_id": "dc2b45a4-3554-4c81-ab55-635d231c2810",
  • "organization_id": "384f0b5f-25a5-4102-85ca-7c4fa43a7832",
  • "property_id": "15587d25-67bd-4b45-8ae4-f8d06f780940",
  • "app_id": "aa68ea62-7ab1-42b7-84da-bbb4d1c54536",
  • "account_id": "c8f6a433-a8a2-481d-83c9-c2ee29681f6b"
}

Get information about the email which will signup

query Parameters
email
required
string

Responses

Response samples

Content type
application/json
{
  • "firstName": "Bob",
  • "lastName": "Marley",
  • "email": "robertnesta@marley.com",
  • "mobilePhone": "5511988885566"
}

Get Account by parameters.

Get the Accounts related to given parameters.

query Parameters
login
string
name
string
phone
string
exclude_attributes
string

Responses

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "string",
  • "type": "string",
  • "role": "GROWER",
  • "ssn": "string",
  • "tutorial_complete": true,
  • "phone": "+5531900000000",
  • "authorities": [
    ],
  • "locale": "string",
  • "clock_format": "ALWAYS_12",
  • "pending_change_password": true,
  • "default_workspace_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "workspaces": [
    ],
  • "login": "string",
  • "country_code": "st",
  • "photo_uri": "string",
  • "email": "user@example.com",
  • "auto_created_org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Get Org Accounts

path Parameters
org_id
required
string
query Parameters
exclude_attributes
string

List of attributes to be excluded, must be separated by comma

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "$ref": "#/components/examples/PagedAccount"
}

Get Orgs' Accounts by Orgs' Ids

Get Accounts by its org's Ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted accounts

exclude_attributes
string

List of attributes to be excluded

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Orgs' Invites by Orgs' Ids and its status

Get Invites by its org's Ids. If an id does not exist, it does not return it.

query Parameters
status_list
string

A comma seperated list of status to be returned in response.

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "$ref": "#/components/examples/PagedInviteStatus"
}

Get Root owners from the orgs that the workspace id is linked

Get Root owners from the orgs that the workspace id is linked. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted accounts

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Accounts from its default workspaces ids

Get Accounts by their default workspace ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted accounts

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Account Management

Access Managements and password info

Send Account Invitation

Request Body schema: application/json
email
required
string

Either email or login must be present

login
string

Either email or login must be present

name
string
password
string

Mandatory when login is sent instead of email

role
string
Array of any (Authority)
by_concierge
boolean
redirect_uri
string
client_id
string

Mandatory when redirect_uri is present

locale
required
string
Enum: "bg" "da" "de" "el" "en" "en_GB" "es" "es_419" "fr" "hi" "hu" "ja" "nl" "pl" "pt_BR" "ro" "sv" "uk"

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "locale": "pt-BR",
  • "name": "string",
  • "type": "USER",
  • "role": "GROWER",
  • "authorities": [
    ]
}

Account Creator for migrating users

Creates an Account for an user using the specified info.

Request Body schema: application/json

This model has the required information to create an Account.

The org_creation_strategy field value behavior is:

  • force: A Company will be created with a default name.
  • no: The user will have to manually create a Company later.
  • auto: The server will decide.
id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

type
required
string
Value: "signup_request"
email
required
string <email>
phone
string (Phone Number)

E.164 international phone number formatting

https://www.itu.int/rec/T-REC-E.164/en
first_name
required
string
last_name
required
string
locale
required
string
role
string (Account Role)
Enum: "GROWER" "MANAGER" "ADMIN" "DEALER" "CONSULTANT" "AGRONOMIST" "OTHER"
identity_provider
string
Enum: "GOOGLE" "MICROSOFT" "SOCIAL"

This is optional, if not present, the user will authenticate itself as usual. "SOCIAL" should be used when an account use an undefined external identity provider.

Responses

Request samples

Content type
application/json
Example
Migration Example with identity_provider
Migration Example with identity_provider
Valid migration example
{
  • "id": "aac63ee2-4727-43ra-8d24-5e6d0wqq9cda",
  • "org_creation_strategy": "auto",
  • "locale": "en",
  • "country_code": "BR",
  • "first_name": "Donald",
  • "last_name": "Byrd",
  • "phone": "+5591900044675",
  • "email": "donald.byrd@gmail.com",
  • "type": "signup_request",
  • "role": "OTHER",
  • "identity_provider": "GOOGLE"
}

Response samples

Content type
application/json
{
  • "name": "user",
  • "type": "USER",
  • "ssn": null,
  • "role": null,
  • "phone": "+91 88976-5467",
  • "locale": "en",
  • "country_code": "BR",
  • "clock_format": "LET_LOCALE_DECIDE",
  • "login": "user_new@email.com",
  • "email": "user_new@email.com",
  • "auto_created_org_id": "85010338-88c4-49ca-a480-79b7146c2058",
  • "opt_ins": [
    ],
  • "id": "d33ecea2-d056-4b1e-890e-76ed045774ab"
}

Apply password change

Apply the password change using a recovery_id.

path Parameters
recovery_id
required
string
Request Body schema: application/json

Represents a new password to be associated with an Account.

email
required
string <email>
new_password
required
string <password> [ 8 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "email": "john@example.com",
  • "new_password": "N3wStr0ngP4_ss"
}

Account recovery mail sender

Sends a link to the account email address that will guide the user to change the account password.

Request Body schema: application/json
email
required
string <email>
locale
required
string
Enum: "pt-BR" "en" "es"
recovery_url
string

Informs the url to be sent on recovery password email.

custom_email_template
boolean

If true, it use the email template of the client_id's app. If the app doesn't have an email template, the default password recovery email template will be used.

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "locale": "pt-BR"
}

Reset password for account

Request Body schema: application/json
account_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

old_password
string
new_password
string

Responses

Request samples

Content type
application/json
{
  • "account_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "old_password": "V3ryStr0ngP4ssw0rd",
  • "new_password": "N3wStr0ngP4_ss"
}

Account Creator

Creates an Account for an user using the specified info.

Request Body schema: application/json

This model has the required information to create an Account.

The org_creation_strategy field value behavior is:

  • force: A Company will be created with a default name.
  • no: The user will have to manually create a Company later.
  • auto: The server will decide.
type
required
string
Value: "signup_request"
email
required
string <email>
phone
required
string (Phone Number)

E.164 international phone number formatting

https://www.itu.int/rec/T-REC-E.164/en
password
required
string <password>
name
required
string
locale
required
string
invite_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

role
string (Account Role)
Enum: "GROWER" "MANAGER" "ADMIN" "DEALER" "CONSULTANT" "AGRONOMIST" "OTHER"
org_creation_strategy
required
string
Enum: "no" "force" "auto"

no - never creates;

auto - creates if not joining from an invite and the inviter indicated the invitee is to join the org upon invite acceptance

force - creates a new org even if invite includes org (still adds user to org invite if present)

terms_accepted_on
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
required
Array of objects (Signup Opt In)
photo_uri
string

Responses

Request samples

Content type
application/json
{
  • "opt_ins": [
    ],
  • "terms_accepted_on": "2019-10-02T15:00:00Z",
  • "org_creation_strategy": "auto",
  • "invite_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "locale": "en",
  • "name": "John Doe",
  • "password": "V3ryStr0ngP4ssw0rd",
  • "phone": "+5531900000000",
  • "email": "john@example.com",
  • "type": "signup_request",
  • "role": "OTHER"
}

Response samples

Content type
application/json
{
  • "name": "user",
  • "authorities": [
    ],
  • "type": "USER",
  • "ssn": null,
  • "role": null,
  • "phone": "+91 88976-5467",
  • "locale": "en",
  • "coutry_code": "BR",
  • "clock_format": "LET_LOCALE_DECIDE",
  • "login": "user_new@email.com",
  • "email": "user_new@email.com",
  • "auto_created_org_id": "85010338-88c4-49ca-a480-79b7146c2058",
  • "photo_uri": "https://photo-uri.com",
  • "opt_ins": [
    ],
  • "id": "d33ecea2-d056-4b1e-890e-76ed045774ab",
  • "default_licensing_account_id": "ed2031da-94eb-4892-9f76-f41cd993c8be",
  • "default_workspace_id": "ed2031da-94eb-4892-9f76-f41cd993c8be"
}

App

App listing, editing and creation

Get authorities by application

List of authorities by App of the user logged

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "size": 2000,
  • "number": 0,
  • "first": true,
  • "number_of_elements": 2,
  • "sort": {
    },
  • "empty": false
}

Enroll an App

** NOTE: ** This is NOT IMPLEMENTED yet. It is still work in progress.

Request Body schema: application/json
name
required
string
short_description
string
published
boolean
supported_apps
Array of objects <uuid> (UUID Canonical textual representation)
site_uri
string <uri>
apple_store_uri
string <uri>
play_store_uri
string <uri>
icon_uri
required
string <uri>
image_uri
string <uri>
type
required
string
detailed_description
string
object
api_version
string
object (AppIntegrations)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_description": "string",
  • "published": true,
  • "supported_apps": [
    ],
  • "site_uri": "http://example.com",
  • "apple_store_uri": "http://example.com",
  • "play_store_uri": "http://example.com",
  • "icon_uri": "http://example.com",
  • "image_uri": "http://example.com",
  • "type": "string",
  • "detailed_description": "string",
  • "authentication": {
    },
  • "api_version": "string",
  • "integrations": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "short_description": "string",
  • "published": true,
  • "supported_apps": [
    ],
  • "site_uri": "http://example.com",
  • "apple_store_uri": "http://example.com",
  • "play_store_uri": "http://example.com",
  • "icon_uri": "http://example.com",
  • "image_uri": "http://example.com",
  • "type": "string",
  • "detailed_description": "string",
  • "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  • "fallback_details_language": "string",
  • "details_review_status": "string"
}

Get authorities by application

List of authorities by App

path Parameters
app_id
required
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "size": 2000,
  • "number": 0,
  • "first": true,
  • "number_of_elements": 2,
  • "sort": {
    },
  • "empty": false
}

Get Campaigns by app

path Parameters
app_id
required
string
query Parameters
last_key
string
size
integer

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get App Icon

Requests the App main icon.

path Parameters
app_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Upload App Icon

Uploads App main icon.

path Parameters
app_id
required
string
Request Body schema: multipart/form-data

Multipart Form including the icon file (png or jpg)

icon
string <binary>

Responses

Response samples

Content type
application/json
{}

Remove App Icon

Removes the App main icon.

path Parameters
app_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Get App Image

Requests the App main image.

path Parameters
app_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Upload App Image

Uploads App image.

path Parameters
app_id
required
string
Request Body schema: multipart/form-data

Multipart Form including the image file (png)

image
string <binary>

Responses

Response samples

Content type
application/json
{}

Remove App Image

Removes the App image.

path Parameters
app_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Get Basic App Info by Id

path Parameters
app_id
required
string
header Parameters
Accept-Language
string

Responses

Response samples

Content type
application/json
{}

App installer

** NOTE: ** This is NOT IMPLEMENTED yet. It is still work in progress.

path Parameters
app_id
required
string
Request Body schema: application/json
required
Array of any (Authority)
org_id
required
object <uuid> (UUID Canonical textual representation) Recursive

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Request samples

Content type
application/json
{
  • "consents": [
    ],
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Get All Oauth2 Clients By App Id

Get oauth2 client by App ID.

path Parameters
app_id
required
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Get Developer App By Id

Get a App by ID.

path Parameters
app_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "f0d59ad7-b2c2-490a-965c-2899fc09c44b",
  • "org_id": "f0d59ad7-b2c2-490a-965c-2899fc09c44b",
  • "name": "Basic App Name",
  • "short_description": "Short description goes here",
  • "detailed_description": "Detailed description goes here",
  • "published": true,
  • "type": "APPLICATION",
  • "supported_apps": [
    ],
  • "site_uri": "http://site-uri.com",
  • "apple_store_uri": "http://apple-uri.com",
  • "play_store_uri": "http://play-uri.com",
  • "icon_uri": "http://icon-uri.com",
  • "image_uri": "http://image-uri.com",
  • "fallback_details_language": "en",
  • "details_review_status": "PENDING"
}

Update Developer App

Update a App.

path Parameters
app_id
required
string
Request Body schema: application/json

Details of the App to be Updated

name
required
string
short_description
string
published
boolean
supported_apps
Array of objects <uuid> (UUID Canonical textual representation)
site_uri
string <uri>
apple_store_uri
string <uri>
play_store_uri
string <uri>
icon_uri
required
string <uri>
image_uri
string <uri>
type
required
string
detailed_description
string
org_id
string <uuid>
fallback_details_language
string
details_review_status
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "f0d59ad7-b2c2-490a-965c-2899fc09c44b",
  • "name": "Basic App Name",
  • "short_description": "Short description goes here",
  • "detailed_description": "Detailed description goes here",
  • "published": true,
  • "type": "APPLICATION",
  • "supported_apps": [
    ],
  • "site_uri": "http://site-uri.com",
  • "apple_store_uri": "http://apple-uri.com",
  • "play_store_uri": "http://play-uri.com",
  • "icon_uri": "http://icon-uri.com",
  • "image_uri": "http://image-uri.com",
  • "fallback_details_language": "en",
  • "details_review_status": "PENDING"
}

Response samples

Content type
application/json
{
  • "id": "f0d59ad7-b2c2-490a-965c-2899fc09c44b",
  • "org_id": "f0d59ad7-b2c2-490a-965c-2899fc09c44b",
  • "name": "Basic App Name",
  • "short_description": "Short description goes here",
  • "detailed_description": "Detailed description goes here",
  • "published": true,
  • "type": "APPLICATION",
  • "supported_apps": [
    ],
  • "site_uri": "http://site-uri.com",
  • "apple_store_uri": "http://apple-uri.com",
  • "play_store_uri": "http://play-uri.com",
  • "icon_uri": "http://icon-uri.com",
  • "image_uri": "http://image-uri.com",
  • "fallback_details_language": "en",
  • "details_review_status": "PENDING"
}

delete-app-by-id

Delete the specified App.

path Parameters
app_id
required
string

Responses

List Developer Apps

** NOTE: ** This is NOT IMPLEMENTED yet. It is still work in progress.

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number": 0,
  • "number_of_elements": 0,
  • "size": 0,
  • "total_elements": 0,
  • "total_pages": 0,
  • "sort": {
    },
  • "pageable": {
    }
}

List Apps

** NOTE: ** This is NOT IMPLEMENTED yet. It is still work in progress. List apps from market place

Responses

Response samples

Content type
application/json
{
  • "content": [],
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number": 0,
  • "number_of_elements": 0,
  • "size": 0,
  • "total_elements": 0,
  • "total_pages": 0,
  • "sort": {
    },
  • "pageable": {
    }
}

Developer App Creator

Create a App.

Request Body schema: application/json

Details of the App to be created

name
required
string
short_description
string
published
boolean
supported_apps
Array of objects <uuid> (UUID Canonical textual representation)
site_uri
string <uri>
apple_store_uri
string <uri>
play_store_uri
string <uri>
icon_uri
required
string <uri>
image_uri
string <uri>
type
required
string
detailed_description
string
org_id
string <uuid>
fallback_details_language
string
details_review_status
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "f0d59ad7-b2c2-490a-965c-2899fc09c44b",
  • "name": "Basic App Name",
  • "short_description": "Short description goes here",
  • "detailed_description": "Detailed description goes here",
  • "published": true,
  • "type": "APPLICATION",
  • "supported_apps": [
    ],
  • "site_uri": "http://site-uri.com",
  • "apple_store_uri": "http://apple-uri.com",
  • "play_store_uri": "http://play-uri.com",
  • "icon_uri": "http://icon-uri.com",
  • "image_uri": "http://image-uri.com",
  • "fallback_details_language": "en",
  • "details_review_status": "PENDING"
}

Response samples

Content type
application/json
{
  • "id": "f0d59ad7-b2c2-490a-965c-2899fc09c44b",
  • "org_id": "f0d59ad7-b2c2-490a-965c-2899fc09c44b",
  • "name": "Basic App Name",
  • "short_description": "Short description goes here",
  • "detailed_description": "Detailed description goes here",
  • "published": true,
  • "type": "APPLICATION",
  • "supported_apps": [
    ],
  • "site_uri": "http://site-uri.com",
  • "apple_store_uri": "http://apple-uri.com",
  • "play_store_uri": "http://play-uri.com",
  • "icon_uri": "http://icon-uri.com",
  • "image_uri": "http://image-uri.com",
  • "fallback_details_language": "en",
  • "details_review_status": "PENDING"
}

Installed apps for Org

Get All Apps

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

parent_region_id
required
object <uuid> (UUID Canonical textual representation)
Example: parent_region_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

attributes
Array of strings
Items Value: "geometry"

Enable geometry in response

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Get App By Id in Store

Get App By Id in Store

path Parameters
app_id
required
string
query Parameters
workspace_id
required
string
include_expired_contracts
boolean

Search for App in Store with expired contract

Responses

Response samples

Content type
application/json
{
  • "id": "f0d59ad7-b2c2-490a-965c-2899fc09c44b",
  • "name": "Basic App Name",
  • "short_description": "Short description goes here",
  • "detailed_description": "Detailed description goes here",
  • "published": true,
  • "site_uri": "http://site-uri.com",
  • "icon_uri": "http://icon-uri.com",
  • "image_uri": "http://image-uri.com"
}

List Apps in Store per workspace

List Apps in Store per workspace, for all the workspaces with at least one organization.

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

filter_by_language
boolean

Filter apps by accept-language header. Default true

include_default_workspace
boolean

Includes the default workspace on the response, even if it doesn't have an org. Default false

include_unpublished
boolean

Returns unpublished apps as well as published ones. Default false

Responses

Response samples

Content type
application/json
{}

List Apps in Store

List Apps in Store

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

workspace_id
object <uuid> (UUID Canonical textual representation)
Example: workspace_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

licensing_account_id
object <uuid> (UUID Canonical textual representation)
Example: licensing_account_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

filter_by_language
string

Filter apps by accept-language header. Default true

include_default_workspace
string

include default workspace. Default false

include_unpublished
string

Include unpublished apps. Default false

include_clients_info
string

Include clients info. Default false

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Billing

Payment

Confirmate a Contract Payment

Confirmate a Contract Payment.

path Parameters
workspace_id
required
string
contract_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Create a Payment Intent

Create a Payment Id and Returns the Payment URL.

path Parameters
workspace_id
required
string
Request Body schema: application/json
payment_page_url
string
object

Responses

Request samples

Content type
application/json
{
  • "payment_page_url": "string",
  • "contract": {
    }
}

Response samples

Content type
application/json
{
  • "price_id": "string",
  • "transaction_mode": "string",
  • "product_quantity": 0,
  • "cancel_callback_url": "string",
  • "success_callback_url": "string",
  • "contract": {
    }
}

Campaigns

Campaign listing, editing and creation

Add Plans to Campaigns

Add a plan to a campaign

path Parameters
campaignId
required
string

Numeric ID of the campaign to toggle activation

Request Body schema: application/json
planId
required
string

Responses

Request samples

Content type
application/json
{
  • "planId": "string"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "duration": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "notes": "string",
  • "plans": [
    ],
  • "voucher_count": 0,
  • "available_vouchers": 0,
  • "shareable_links": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "sv": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vouchers": [
    ]
}

Delete Campaign

Removes a single campaign

path Parameters
campaignId
required
string

Numeric ID of the campaign to remove

Responses

Response samples

Content type
application/json
{
  • "status": "campaign deleted successfully"
}

Get Campaign By Id

Get a single campaign

path Parameters
campaignId
required
string

Numeric ID of the campaign to get

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "duration": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "notes": "string",
  • "plans": [
    ],
  • "voucher_count": 0,
  • "available_vouchers": 0,
  • "shareable_links": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "sv": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vouchers": [
    ]
}

Edit Campaign

Updates a single campaign

path Parameters
campaignId
required
string

Numeric ID of the campaign to update

Request Body schema: application/json
name
string
active
boolean
duration
number
start_date
string
notes
string
voucher_count
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": true,
  • "duration": 0,
  • "start_date": "string",
  • "notes": "string",
  • "voucher_count": 0
}

Response samples

Content type
application/json
{
  • "active": true,
  • "duration": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "notes": "string",
  • "plans": [
    ],
  • "voucher_count": 0,
  • "available_vouchers": 0,
  • "shareable_links": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "sv": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vouchers": [
    ]
}

Toggle Campaign Activation

Toggles the activation of a campaign

path Parameters
campaignId
required
string

Numeric ID of the campaign to toggle activation

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "duration": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "notes": "string",
  • "plans": [
    ],
  • "voucher_count": 0,
  • "available_vouchers": 0,
  • "shareable_links": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "sv": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vouchers": [
    ]
}

Get Campaign Vouchers

Get all vouchers from a campaign

path Parameters
campaignId
required
string

Numeric ID of the campaign to get

query Parameters
size
integer

Number of vouchers to return

last_key
string

Id of the last voucher returned by the previous query

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Add Vouchers to Campaign

Add vouchers to a campaign

path Parameters
campaignId
required
string

Numeric ID of the campaign to toggle activation

Request Body schema: application/json
amount
required
number

Responses

Request samples

Content type
application/json
{
  • "amount": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Get all campaigns

Get all campaigns

query Parameters
size
integer

Number of campaigns to return

last_key
string

Id of the last campaign returned by the previous query

name
string

Name or name fragment of campaign name to filter

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Create Campaign

Creates a new campaign

Request Body schema: application/json
name
required
string
active
required
boolean
duration
required
number
start_date
required
string
notes
string
Array of objects
voucher_count
required
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": true,
  • "duration": 0,
  • "start_date": "string",
  • "notes": "string",
  • "plans": [
    ],
  • "voucher_count": 0
}

Response samples

Content type
application/json
{
  • "active": true,
  • "duration": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "notes": "string",
  • "plans": [
    ],
  • "voucher_count": 0,
  • "available_vouchers": 0,
  • "shareable_links": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "sv": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vouchers": [
    ]
}

Catalog Crop

Catalog Crop Crop listing, editing and creation

Get Crop By Id

Get Crop By Id, if location is added to query, return Localized Crop

path Parameters
crop_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
location
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": [
    ],
  • "localized_crops": [
    ],
  • "image_url": "string",
  • "icon": "string",
  • "specialization_type": "string",
  • "label": "string",
  • "scientific_name": "string",
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "eppo_code": "string"
}

Delete a crop

Delete Crop By Id

path Parameters
crop_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Edit Crop

Edit a crop by Id

path Parameters
crop_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Request Body schema: application/json
Array of objects (CropNameModel)
Array of objects (LocalizedCrop)
specialization_type
string
icon
string
label
string
image_url
string
eppo_code
string
parent_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Request samples

Content type
application/json
{
  • "name": [
    ],
  • "localized_crops": [
    ],
  • "specialization_type": "string",
  • "icon": "string",
  • "label": "string",
  • "image_url": "string",
  • "eppo_code": "string",
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": [
    ],
  • "localized_crops": [
    ],
  • "image_url": "string",
  • "icon": "string",
  • "specialization_type": "string",
  • "label": "string",
  • "scientific_name": "string",
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "eppo_code": "string"
}

Create a Crop

Request Body schema: application/json
Array of objects (CropNameModel)
Array of objects (LocalizedCrop)
specialization_type
string
icon
string
label
string
image_url
string
eppo_code
string
parent_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Request samples

Content type
application/json
{
  • "name": [
    ],
  • "localized_crops": [
    ],
  • "specialization_type": "string",
  • "icon": "string",
  • "label": "string",
  • "image_url": "string",
  • "eppo_code": "string",
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": [
    ],
  • "localized_crops": [
    ],
  • "image_url": "string",
  • "icon": "string",
  • "specialization_type": "string",
  • "label": "string",
  • "eppo_code": "string",
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Get all crops from catalog

query Parameters
size
number
page
number

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Catalog Crop Eppo

Catalog Crop Eppo listing, editing and creation

Edit an Eppo

Edit Eppo

path Parameters
eppo_code
required
string
Request Body schema: application/json
scientific_name
required
string
en_name
required
string

Responses

Request samples

Content type
application/json
{
  • "scientific_name": "Vitis vinifera",
  • "en_name": "Grape"
}

Response samples

Content type
application/json
{
  • "created_by": null,
  • "updated_by": null,
  • "deleted_at": null,
  • "created_at": "2023-04-05T20:49:28.000Z",
  • "updated_at": "2023-04-05T20:49:28.000Z",
  • "id": "f3a33bab-0f3a-4eab-beee-99e6395ac61d",
  • "eppo_code": "VITVI",
  • "scientific_name": "Vitis vinifera",
  • "en_name": "Grape"
}

Get Eppo by Code

Get Eppos Code

path Parameters
eppo_code
required
string

Responses

Response samples

Content type
application/json
{
  • "created_by": null,
  • "updated_by": null,
  • "deleted_at": null,
  • "created_at": "2023-04-05T20:49:28.000Z",
  • "updated_at": "2023-04-05T20:49:28.000Z",
  • "id": "f3a33bab-0f3a-4eab-beee-99e6395ac61d",
  • "eppo_code": "VITVI",
  • "scientific_name": "Vitis vinifera",
  • "en_name": "Grape"
}

Delete Eppos

delete Eppos Code

path Parameters
eppo_code
required
string

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Create New Eppo

Create New Eppo

Request Body schema: application/json
eppo_code
required
string
scientific_name
required
string
en_name
required
string

Responses

Request samples

Content type
application/json
{
  • "eppo_code": "VITVI",
  • "scientific_name": "Vitis vinifera",
  • "en_name": "Grape"
}

Response samples

Content type
application/json
{
  • "created_by": null,
  • "updated_by": null,
  • "deleted_at": null,
  • "created_at": "2023-04-05T20:49:28.000Z",
  • "updated_at": "2023-04-05T20:49:28.000Z",
  • "id": "f3a33bab-0f3a-4eab-beee-99e6395ac61d",
  • "eppo_code": "VITVI",
  • "scientific_name": "Vitis vinifera",
  • "en_name": "Grape"
}

Get All Eppos

Get All Eppos Codes

query Parameters
size
number
page
number

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Verify Eppos

Verify Eppos

Request Body schema: application/json
eppos
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "eppos": [
    ]
}

Response samples

Content type
application/json
{
  • "valid_eppos": [
    ],
  • "invalid_eppos": [
    ]
}

Catalog Crop Growth Scale

Catalog Crop Growth Scale listing, editing and creation

Get Growth Scale By Id

Get Growth Scale By Id

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "growth_stages": [
    ]
}

Update Growth Scale By Id

Update Growth Scale By Id

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Request Body schema: application/json
name
required
string
org_id
string
required
Array of objects (Growth-Stage)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "org_id": "string",
  • "growht_stages": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "growth_stages": [
    ]
}

Delete Growth Scale By Id

Delete Growth Scale By Id

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Get all Localized Crops from a growth scale

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "Growth Scale",
  • "localized_crops": [
    ]
}

Associate a growth scale with localized crops

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "relationship": [
    ]
}

Response samples

Content type
application/json
{
  • "succeeded": [
    ],
  • "failed": [
    ]
}

Create Growth Scale Allocation

Create Growth Scale Allocation

Request Body schema: application/json
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

growth_scale
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

crop_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

location
required
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "growth_scale": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "crop_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "location": "string"
}

Response samples

Content type
application/json
{
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "localized_crop": "string",
  • "growth_scale": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Get All Growth Scales Associated With Org

Get All Growth Scales Associated With Org using org id, crop id, location

query Parameters
crop_id
required
string
org_id
required
string
location
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Growth Scale

Create a Growth Scale

Request Body schema: application/json
id
string
name
string
org_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Array of objects (Growth-Stage)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "growth_stages": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "org_id": "string",
  • "growht_stages": [
    ]
}

Get Growth Scales By Localized Crop

Responses

Response samples

Content type
application/json
{
  • "non_default": [
    ],
  • "default": {
    }
}

Get All Growth Scales Without OrgId

query Parameters
page
number
size
number

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Catalog Product

Catalog Product listing, editing and creation

Get an Organization's Product in the Catalog

Get Organization Custom and Canon Products.

path Parameters
org_id
required
string <uuid>
query Parameters
full
boolean

If all product's attributes will be returned or not. Default is false.

include_hidden
boolean

If hidden products will be returned or not. Default is false

include_deleted
boolean

If deleted products will be returned or not. Default is false

include_attributes
Array of strings

Which attributes will be included in the response. They will appear only if they do exist.

indication
string (ProductIndication)
Enum: "ACARICIDE" "ACARICIDE(MICROBIOLOGICAL)" "ACARICIDE/ADHESIVE(SPREADER)/ADJUVANT/INSECTICIDE" "ACARICIDE/ADJUVANT/INSECTICIDE" "ACARICIDE/ADJUVANT/INSECTICIDE/NEMATICIDE" "ACARICIDE/ATTRACTANT/INSECTICIDE" "ACARICIDE/BACTERICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE/INSECTICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE/INSECTICIDE/SEED-TREATMENT" "ACARICIDE/FORMICIDE/INSECTICIDE" "ACARICIDE/FUMIGANT" "ACARICIDE/FUNGICIDE" "ACARICIDE/FUNGICIDE/INSECTICIDE" "ACARICIDE/FUNGICIDE/INSECTICIDE/NEMATICIDE/RODENTICIDE" "ACARICIDE/GROWTH-REGULATOR/INSECTICIDE" "ACARICIDE/HERBICIDE/NEMATICIDE" "ACARICIDE/INSECT-GROWTH-REGULATOR/INSECTICIDE" "ACARICIDE/INSECTICIDE" "ACARICIDE/INSECTICIDE(MICROBIOLOGICAL)" "ACARICIDE/INSECTICIDE/INSECT-REPELLENT/MOLLUSCICIDE" "ACARICIDE/INSECTICIDE/MOLLUSCICIDE" "ACARICIDE/INSECTICIDE/NEMATICIDE" "ACARICIDE/INSECTICIDE/PROD.-AGAINST-STORAGE-PESTS" "ACARICIDE/INSECTICIDE/RODENTICIDE" "ACARICIDE/INSECTICIDE/SEED-PROTECTANT" "ACARICIDE/INSECTICIDE/SEED-TREATMENT" "ACARICIDE/MOLLUSCICIDE/TADPOLE-SH" "ACARICIDE/REPELLENT" "ACRIDICIDE" "ACRIDICIDE/INSECTICIDE" "ACTIVATOR" "ADHESIVE(SPREADER)" "ADHESIVE(SPREADER)/ADJUVANT" "ADHESIVE(SPREADER)/ADJUVANT/FUNGICIDE" "ADJUVANT" "ADJUVANT/ACARICIDE/FUNGICIDE/INSECTICIDE" "ADJUVANT/FUNGICIDE/INSECTICIDE" "ADJUVANT/GROWTH-REGULATOR" "ADJUVANT/HERBICIDE" "ADJUVANT/HERBICIDE/SURFACTANT" "ADJUVANT/INSECTICIDE" "ADJUVANT/SURFACTANT" "ALGAECIDE" "ALGAECIDE/FUNGICIDE" "ALGAECIDE/FUNGICIDE/SLIMICIDE" "ALGAECIDE/HERBICIDE" "ALGAECIDE/HERBICIDE/MOLLUSCICIDE" "ALGAECIDE/SANITIZER/SLIMICIDE/BACTERICIDE" "ALGAECIDE/SLIMICIDE" "ALGICIDE" "ANIMAL-TOXICANT" "ANIMAL-TOXICANT/INSECTICIDE/RODENTICIDE" "ANIMAL-TOXICANT/RODENTICIDE" "ANTI-FOAMING" "ANTI-FOULING-PAINT" "ANTI-MOSS" "ANTI-MOSS/HERBICIDE" "ANTI-SCALD" "ANTI-SPROUTING" "ATTRACTANT" "ATTRACTANT/INSECTICIDE" "AVICIDE" "BACTERICIDE" "BACTERICIDE/DISINFECTANT/FUNGICIDE" "BACTERICIDE/FUMIGANT/FUNGICIDE" "BACTERICIDE/FUNGICIDE" "BACTERICIDE/FUNGICIDE(MICROBIOLOGICAL)" "BACTERICIDE/FUNGICIDE/GROWTH-REGULATOR" "BACTERICIDE/FUNGICIDE/INSECTICIDE" "BACTERICIDE/FUNGICIDE/MOLLUSCICIDE" "BACTERICIDE/FUNGICIDE/NEMATICIDE" "BACTERICIDE/FUNGICIDE/NEMATICIDE/SOIL-DISINFECTANT" "BACTERICIDE/FUNGICIDE/SEED-TREATMENT" "BACTERICIDE/FUNGICIDE/SOIL-DISINFECTANT" "BACTERICIDE/FUNGICIDE/SPORICIDE" "BACTERICIDE/FUNGICIDE/VIRUCIDE" "BACTERICIDE/GROWTH-REGULATOR" "BACTERICIDE/INSECTICIDE" "BACTERICIDE/NEMATICIDE" "BAIT" "BIO-FUNGICIDE" "BIO-INSECTICIDE" "BIO-NEMATICIDE" "BIOCHEMICAL-PESTICIDE" "BIOLOGICAL-CONTROL-AGENT" "BIOLOGICAL-CONTROL-PRODUCT" "BIOLOGICAL-CTRL.-PROD./INSECTICIDE" "BIOLOGICAL-CTRL.-PROD./NEMATICIDE" "BIOLOGICAL-CTRL.-PROD./VIRUCIDE" "BIOSTIMULANT" "BIRD-REPELLENT" "BUFFER-AGENT" "CROP-BACTERICIDE" "CROP-BACTERICIDE/FUNGICIDE" "CROP-BACTERICIDE/FUNGICIDE/HERBICIDE" "CRUSTICIDE" "CRUSTICIDE/MOLLUSCICIDE" "DEFOLIANT" "DEFOLIANT/DESICCANT" "DEFOLIANT/DESICCANT/HERBICIDE" "DEFOLIANT/DESICCANT/REGULATOR" "DEFOLIANT/GROWTH-REGULATOR(PGR)" "DEFOLIANT/HERBICIDE" "DEFOLIANT/HERBICIDE/REGULATOR" "DEFOLIANT/REGULATOR" "DESICCANT" "DESICCANT/HERBICIDE" "DESICCANT/HERBICIDE/REGULATOR" "DESICCANT/MICROBIAL/REGULATOR" "DISINFECTANT" "DISINFECTANT/FUNGICIDE/HERBICIDE/NEMATICIDE" "DISINFECTANT/FUNGICIDE/NEMATICIDE" "DISINFECTANT/INSECTICIDE" "DISINFECTANT/PRESERVATIVE" "DISINFECTANT/SEED-TREATMENT" "ELICITOR" "FERTILIZER/SOIL-CONDITIONER" "FORMICIDE" "FORMICIDE/FUNGICIDE" "FORMICIDE/FUNGICIDE/INSECTICIDE/NEMATICIDE" "FORMICIDE/INSECTICIDE" "FORMICIDE/INSECTICIDE/RODENTICIDE" "FORMICIDE/INSECTICIDE/SEED-TREATMENT" "FORMICIDE/INSECTICIDE/TERMITICIDE" "FUMIGANT" "FUMIGANT/FUNGICIDE" "FUMIGANT/INSECTICIDE" "FUMIGANT/INSECTICIDE/MOLLUSCICIDE/TADPOLE-SH" "FUMIGANT/INSECTICIDE/RODENTICIDE" "FUMIGANT/NEMATICIDE" "FUMIGANT/SEED-TREATMENT" "FUNGICIDE" "FUNGICIDE" "FUNGICIDE(MICROBIOLOGICAL)" "FUNGICIDE/ACARICIDE" "FUNGICIDE/DISINFECTANT/PRESERVATIVE" "FUNGICIDE/GROWTH-REGULATOR" "FUNGICIDE/GROWTH-REGULATOR/HERBICIDE" "FUNGICIDE/GROWTH-REGULATOR/INSECTICIDE" "FUNGICIDE/GROWTH-REGULATOR/SEED-PROTECTANT" "FUNGICIDE/HERBICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE/RODENTICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/INSECTICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/INSECTICIDE/VIRUCIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE/NEMATICIDE/TADPOLE-SH" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE/TADPOLE-SH" "FUNGICIDE/HERBICIDE/NEMATICIDE" "FUNGICIDE/HERBICIDE/NEMATICIDE/SLIMICIDE" "FUNGICIDE/HERBICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/NEMATICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/HERBICIDE/REGULATOR" "FUNGICIDE/HERBICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/INSECT-GROWTH-REGULATOR/INSECTICIDE" "FUNGICIDE/INSECTICIDE" "FUNGICIDE/INSECTICIDE/MICROBIAL" "FUNGICIDE/INSECTICIDE/MICROBIAL/REGULATOR" "FUNGICIDE/INSECTICIDE/MISCELLANEOUS" "FUNGICIDE/INSECTICIDE/MOLLUSCICIDE/NEMATICIDE" "FUNGICIDE/INSECTICIDE/NEMATICIDE" "FUNGICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/INSECTICIDE/REGULATOR" "FUNGICIDE/INSECTICIDE/REPELLENT" "FUNGICIDE/INSECTICIDE/RODENTICIDE" "FUNGICIDE/INSECTICIDE/SEED-PROTECTANT" "FUNGICIDE/INSECTICIDE/SEED-TREATMENT" "FUNGICIDE/INSECTICIDE/VIRUCIDE" "FUNGICIDE/INSECTICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/MATERIAL-PRESERVATIVE" "FUNGICIDE/MICROBIAL" "FUNGICIDE/MICROBIAL/REGULATOR" "FUNGICIDE/MOLLUSCICIDE" "FUNGICIDE/NEMATICIDE" "FUNGICIDE/NEMATICIDE(MICROBIOLOGICAL)" "FUNGICIDE/NEMATICIDE/PLANT-GROWTH-REGULATOR" "FUNGICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/REGULATOR" "FUNGICIDE/REPELLENT" "FUNGICIDE/SANITIZER" "FUNGICIDE/SEED-PROTECTANT" "FUNGICIDE/SEED-TREATMENT" "FUNGICIDE/SEED-TREATMENT/BIO-FERTILIZER" "FUNGICIDE/SPORICIDE/TUBERCULOCIDE/VIRUCIDE" "FUNGICIDE/TUBERCULOCIDE/VIRUCIDE" "FUNGICIDE/VIRUCIDE" "FUNGICIDE/WOOD-PRESERVATIVE" "FUNGISTAT" "GROWTH-REGULATOR(PGR)" "GROWTH-REGULATOR(PGR)/WOUND-TREATMENT" "GROWTH-REGULATOR/GROWTH-STIMULANT" "GROWTH-REGULATOR/HERBICIDE" "GROWTH-REGULATOR/HERBICIDE/INSECTICIDE" "GROWTH-REGULATOR/INSECTICIDE" "GROWTH-REGULATOR/NEMATICIDE" "GROWTH-REGULATOR/REPELLENT" "GROWTH-REGULATOR/SEED-PROTECTANT" "GROWTH-STIMULANT" "GROWTH-STIMULANT/NEMATICIDE" "HERBICIDE" "HERBICIDE" "HERBICIDE-W/FERTILIZER" "HERBICIDE/INSECTICIDE" "HERBICIDE/INSECTICIDE/ACATICIDE" "HERBICIDE/INSECTICIDE/NEMATICIDE" "HERBICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "HERBICIDE/MICROBIAL-PESTICIDE" "HERBICIDE/REGULATOR" "HERBICIDE/SAFENER" "IMMUNITY-STIMULATOR" "INOCULANT" "INSECT-GROWTH-REGULATOR" "INSECT-GROWTH-REGULATOR/INSECTICIDE" "INSECT-GROWTH-REGULATOR/INSECTICIDE/NEMATICIDE" "INSECT-GROWTH-REGULATOR/INSECTICIDE/REPELLENT" "INSECT-GROWTH-REGULATOR/REPELLENT" "INSECT-GROWTH-REGULATOR/SEX-ATTRACTANT" "INSECT-REPELLENT" "INSECTICIDE" "INSECTICIDE" "INSECTICIDE-SYNERGIST/SAFENER" "INSECTICIDE(MICROBIOLOGICAL)" "INSECTICIDE(SOAP)" "INSECTICIDE(SOAP)/INSECTICIDE" "INSECTICIDE/CRUSTICIDE" "INSECTICIDE/MATING-DISRUPTANT" "INSECTICIDE/MICROBIAL-PESTICIDE" "INSECTICIDE/MOLLUSCICIDE" "INSECTICIDE/MOLLUSCICIDE/REGULATOR/TADPOLE-SH" "INSECTICIDE/MOLLUSCICIDE/TADPOLE-SH" "INSECTICIDE/NEMATICIDE" "INSECTICIDE/NEMATICIDE/REPELLENT" "INSECTICIDE/NEMATICIDE/SEED-TREATMENT" "INSECTICIDE/NEMATICIDE/SEX-ATTRACTANT" "INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "INSECTICIDE/PHEROMONE" "INSECTICIDE/REPELLENT" "INSECTICIDE/RODENTICIDE" "INSECTICIDE/SEED-TREATMENT" "INSECTICIDE/TERMITICIDE" "INSECTICIDE/VERMIN-DESTROYER" "INSECTICIDE/VIRUCIDE" "INSECTICIDE/WOOD-PRESERVATIVE" "LIMACIDE" "LIVING-ORGANISMS" "LIVING-ORGANISMS(AGAINST-FUNGI)" "LIVING-ORGANISMS(AGAINST-FUNGI)/FUNGICIDE" "LIVING-ORGANISMS(BACTERIA)/FUNGICIDE" "LIVING-ORGANISMS(FUNGI)" "LIVING-ORGANISMS(FUNGI)/FUNGICIDE" "LIVING-ORGANISMS(INSECTS)" "LIVING-ORGANISMS(INSECTS)/PRESERVATIVE" "LIVING-ORGANISMS(MITES)" "LIVING-ORGANISMS(NEMATODES)" "LIVING-ORGANISMS(NEMATODES)/INSECTICIDE" "MATING-DISRUPTANT" "MATING-DISRUPTANT/SEX-ATTRACTANT" "MICROBIAL-PESTICIDE" "MICROBIAL-PESTICIDE/MOLLUSCICIDE/TADPOLE-SH" "MICROBIAL-PESTICIDE/NEMATICIDE" "MICROBIAL-PESTICIDE/REGULATOR" "MICROBIAL-PESTICIDE/SEX-ATTRACTANT" "MICRONUTRIENTS" "MISCELLANEOUS" "MOLLUSCICIDE" "MOLLUSCICIDE/REPELLENT" "MOLLUSCICIDE/SLIMICI" "MOLLUSCICIDE/TADPOLE-SH" "NATURAL-DEFENCE-STIMULATOR" "NEMATICIDE" "NEMATICIDE" "NEMATICIDE(MICROBIOLOGICAL)" "NEMATICIDE/REGULATOR" "NEMATICIDE/SEX-ATTRACTANT" "NEMATICIDE/SOIL-FUMIGANT" "NON-PARASITIC-PLANT-DISEASE-CONTROL" "ORGANISMS(INSECT-VIRUSES)" "OTHER" "OTHERS" "PESTICIDE/FERTILIZER" "PHEROMONE" "PHEROMONE-SYNTHETIC" "PHYSICAL-CONTROL-AGENT" "PLANT GROWTH REGULATO" "PLANT-ACTIVATOR" "PRESERVATIVE" "PRESERVATIVE/INSECTICIDE" "PRODUCT-AGAINST-STORAGE-PESTS" "PROTECTANT" "PRUNING-PAINT" "REGULATOR" "REPELLENT" "RODENT/REPELLENT" "RODENTICIDE" "RODENTICIDE" "SAFENER" "SEED TREATMENT" "SEED-PROTECTANT" "SEED-TREATMENT" "SOIL-DISINFECTANT" "SOIL-DISINFECTANT/NEMATICIDE" "SOIL-FUMIGANT" "SOIL-STERILANT" "SPECIAL-PREPARATIONS" "SPORICIDE" "SPORICIDE/VIRUCIDE" "STERILIZING-PLANTING-AGENT" "SULPHUR" "SURFACTANT/FRUIT-COATING" "TALPICIDE" "TANK-MIX" "TECHNICAL" "TERMITICIDE" "TUBERCULOCIDE/VIRUCIDE" "UNSPECIFIED" "VIRUCIDE" "WAX" "WETTING" "WOOD-PRESERVATIVE" "WOUND-TREATMENT"

Requested product's type.

source
string

Requested source. Default is organization's source

name
string

Requested product's name. Search by "begins_with" and insensitive case.

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "number_of_elements": 3,
  • "last": true,
  • "first": true,
  • "empty": false
}

Change the visibility of a canon product for a organization

Change Catalog Canon Product's Visibility.

Request Body schema: application/json

Hidden and Unhidden data

required
Array of objects (ProductVisibilityDTO)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "success": [
    ],
  • "errors": [ ]
}

Delete a Custom Product in the Catalog

Delete Catalog Custom Product.

path Parameters
product_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Get a Product in the Catalog

Get Catalog Custom Product.

path Parameters
product_id
required
string <uuid>
query Parameters
full
boolean

Gets All the information about the product

include_deleted
boolean

Include deleted products on search

include_attributes
string

Add attributes to the product

Responses

Response samples

Content type
application/json
{
  • "name": "Product navigate",
  • "indication": "ACARICIDE",
  • "selling_units": "LITERS",
  • "id": "f801e123-206e-4821-8ed0-b6a06fc029cf",
  • "deleted": false,
  • "org_id": "8521b1d2-23c4-4340-bbc8-eb787f0edd4e"
}

Edit a Custom Product in the Catalog

Delete Catalog Custom Product.

path Parameters
product_id
required
string <uuid>
Request Body schema: application/json
name
required
string
indication
required
string (ProductIndication)
Enum: "ACARICIDE" "ACARICIDE(MICROBIOLOGICAL)" "ACARICIDE/ADHESIVE(SPREADER)/ADJUVANT/INSECTICIDE" "ACARICIDE/ADJUVANT/INSECTICIDE" "ACARICIDE/ADJUVANT/INSECTICIDE/NEMATICIDE" "ACARICIDE/ATTRACTANT/INSECTICIDE" "ACARICIDE/BACTERICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE/INSECTICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE/INSECTICIDE/SEED-TREATMENT" "ACARICIDE/FORMICIDE/INSECTICIDE" "ACARICIDE/FUMIGANT" "ACARICIDE/FUNGICIDE" "ACARICIDE/FUNGICIDE/INSECTICIDE" "ACARICIDE/FUNGICIDE/INSECTICIDE/NEMATICIDE/RODENTICIDE" "ACARICIDE/GROWTH-REGULATOR/INSECTICIDE" "ACARICIDE/HERBICIDE/NEMATICIDE" "ACARICIDE/INSECT-GROWTH-REGULATOR/INSECTICIDE" "ACARICIDE/INSECTICIDE" "ACARICIDE/INSECTICIDE(MICROBIOLOGICAL)" "ACARICIDE/INSECTICIDE/INSECT-REPELLENT/MOLLUSCICIDE" "ACARICIDE/INSECTICIDE/MOLLUSCICIDE" "ACARICIDE/INSECTICIDE/NEMATICIDE" "ACARICIDE/INSECTICIDE/PROD.-AGAINST-STORAGE-PESTS" "ACARICIDE/INSECTICIDE/RODENTICIDE" "ACARICIDE/INSECTICIDE/SEED-PROTECTANT" "ACARICIDE/INSECTICIDE/SEED-TREATMENT" "ACARICIDE/MOLLUSCICIDE/TADPOLE-SH" "ACARICIDE/REPELLENT" "ACRIDICIDE" "ACRIDICIDE/INSECTICIDE" "ACTIVATOR" "ADHESIVE(SPREADER)" "ADHESIVE(SPREADER)/ADJUVANT" "ADHESIVE(SPREADER)/ADJUVANT/FUNGICIDE" "ADJUVANT" "ADJUVANT/ACARICIDE/FUNGICIDE/INSECTICIDE" "ADJUVANT/FUNGICIDE/INSECTICIDE" "ADJUVANT/GROWTH-REGULATOR" "ADJUVANT/HERBICIDE" "ADJUVANT/HERBICIDE/SURFACTANT" "ADJUVANT/INSECTICIDE" "ADJUVANT/SURFACTANT" "ALGAECIDE" "ALGAECIDE/FUNGICIDE" "ALGAECIDE/FUNGICIDE/SLIMICIDE" "ALGAECIDE/HERBICIDE" "ALGAECIDE/HERBICIDE/MOLLUSCICIDE" "ALGAECIDE/SANITIZER/SLIMICIDE/BACTERICIDE" "ALGAECIDE/SLIMICIDE" "ALGICIDE" "ANIMAL-TOXICANT" "ANIMAL-TOXICANT/INSECTICIDE/RODENTICIDE" "ANIMAL-TOXICANT/RODENTICIDE" "ANTI-FOAMING" "ANTI-FOULING-PAINT" "ANTI-MOSS" "ANTI-MOSS/HERBICIDE" "ANTI-SCALD" "ANTI-SPROUTING" "ATTRACTANT" "ATTRACTANT/INSECTICIDE" "AVICIDE" "BACTERICIDE" "BACTERICIDE/DISINFECTANT/FUNGICIDE" "BACTERICIDE/FUMIGANT/FUNGICIDE" "BACTERICIDE/FUNGICIDE" "BACTERICIDE/FUNGICIDE(MICROBIOLOGICAL)" "BACTERICIDE/FUNGICIDE/GROWTH-REGULATOR" "BACTERICIDE/FUNGICIDE/INSECTICIDE" "BACTERICIDE/FUNGICIDE/MOLLUSCICIDE" "BACTERICIDE/FUNGICIDE/NEMATICIDE" "BACTERICIDE/FUNGICIDE/NEMATICIDE/SOIL-DISINFECTANT" "BACTERICIDE/FUNGICIDE/SEED-TREATMENT" "BACTERICIDE/FUNGICIDE/SOIL-DISINFECTANT" "BACTERICIDE/FUNGICIDE/SPORICIDE" "BACTERICIDE/FUNGICIDE/VIRUCIDE" "BACTERICIDE/GROWTH-REGULATOR" "BACTERICIDE/INSECTICIDE" "BACTERICIDE/NEMATICIDE" "BAIT" "BIO-FUNGICIDE" "BIO-INSECTICIDE" "BIO-NEMATICIDE" "BIOCHEMICAL-PESTICIDE" "BIOLOGICAL-CONTROL-AGENT" "BIOLOGICAL-CONTROL-PRODUCT" "BIOLOGICAL-CTRL.-PROD./INSECTICIDE" "BIOLOGICAL-CTRL.-PROD./NEMATICIDE" "BIOLOGICAL-CTRL.-PROD./VIRUCIDE" "BIOSTIMULANT" "BIRD-REPELLENT" "BUFFER-AGENT" "CROP-BACTERICIDE" "CROP-BACTERICIDE/FUNGICIDE" "CROP-BACTERICIDE/FUNGICIDE/HERBICIDE" "CRUSTICIDE" "CRUSTICIDE/MOLLUSCICIDE" "DEFOLIANT" "DEFOLIANT/DESICCANT" "DEFOLIANT/DESICCANT/HERBICIDE" "DEFOLIANT/DESICCANT/REGULATOR" "DEFOLIANT/GROWTH-REGULATOR(PGR)" "DEFOLIANT/HERBICIDE" "DEFOLIANT/HERBICIDE/REGULATOR" "DEFOLIANT/REGULATOR" "DESICCANT" "DESICCANT/HERBICIDE" "DESICCANT/HERBICIDE/REGULATOR" "DESICCANT/MICROBIAL/REGULATOR" "DISINFECTANT" "DISINFECTANT/FUNGICIDE/HERBICIDE/NEMATICIDE" "DISINFECTANT/FUNGICIDE/NEMATICIDE" "DISINFECTANT/INSECTICIDE" "DISINFECTANT/PRESERVATIVE" "DISINFECTANT/SEED-TREATMENT" "ELICITOR" "FERTILIZER/SOIL-CONDITIONER" "FORMICIDE" "FORMICIDE/FUNGICIDE" "FORMICIDE/FUNGICIDE/INSECTICIDE/NEMATICIDE" "FORMICIDE/INSECTICIDE" "FORMICIDE/INSECTICIDE/RODENTICIDE" "FORMICIDE/INSECTICIDE/SEED-TREATMENT" "FORMICIDE/INSECTICIDE/TERMITICIDE" "FUMIGANT" "FUMIGANT/FUNGICIDE" "FUMIGANT/INSECTICIDE" "FUMIGANT/INSECTICIDE/MOLLUSCICIDE/TADPOLE-SH" "FUMIGANT/INSECTICIDE/RODENTICIDE" "FUMIGANT/NEMATICIDE" "FUMIGANT/SEED-TREATMENT" "FUNGICIDE" "FUNGICIDE" "FUNGICIDE(MICROBIOLOGICAL)" "FUNGICIDE/ACARICIDE" "FUNGICIDE/DISINFECTANT/PRESERVATIVE" "FUNGICIDE/GROWTH-REGULATOR" "FUNGICIDE/GROWTH-REGULATOR/HERBICIDE" "FUNGICIDE/GROWTH-REGULATOR/INSECTICIDE" "FUNGICIDE/GROWTH-REGULATOR/SEED-PROTECTANT" "FUNGICIDE/HERBICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE/RODENTICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/INSECTICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/INSECTICIDE/VIRUCIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE/NEMATICIDE/TADPOLE-SH" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE/TADPOLE-SH" "FUNGICIDE/HERBICIDE/NEMATICIDE" "FUNGICIDE/HERBICIDE/NEMATICIDE/SLIMICIDE" "FUNGICIDE/HERBICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/NEMATICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/HERBICIDE/REGULATOR" "FUNGICIDE/HERBICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/INSECT-GROWTH-REGULATOR/INSECTICIDE" "FUNGICIDE/INSECTICIDE" "FUNGICIDE/INSECTICIDE/MICROBIAL" "FUNGICIDE/INSECTICIDE/MICROBIAL/REGULATOR" "FUNGICIDE/INSECTICIDE/MISCELLANEOUS" "FUNGICIDE/INSECTICIDE/MOLLUSCICIDE/NEMATICIDE" "FUNGICIDE/INSECTICIDE/NEMATICIDE" "FUNGICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/INSECTICIDE/REGULATOR" "FUNGICIDE/INSECTICIDE/REPELLENT" "FUNGICIDE/INSECTICIDE/RODENTICIDE" "FUNGICIDE/INSECTICIDE/SEED-PROTECTANT" "FUNGICIDE/INSECTICIDE/SEED-TREATMENT" "FUNGICIDE/INSECTICIDE/VIRUCIDE" "FUNGICIDE/INSECTICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/MATERIAL-PRESERVATIVE" "FUNGICIDE/MICROBIAL" "FUNGICIDE/MICROBIAL/REGULATOR" "FUNGICIDE/MOLLUSCICIDE" "FUNGICIDE/NEMATICIDE" "FUNGICIDE/NEMATICIDE(MICROBIOLOGICAL)" "FUNGICIDE/NEMATICIDE/PLANT-GROWTH-REGULATOR" "FUNGICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/REGULATOR" "FUNGICIDE/REPELLENT" "FUNGICIDE/SANITIZER" "FUNGICIDE/SEED-PROTECTANT" "FUNGICIDE/SEED-TREATMENT" "FUNGICIDE/SEED-TREATMENT/BIO-FERTILIZER" "FUNGICIDE/SPORICIDE/TUBERCULOCIDE/VIRUCIDE" "FUNGICIDE/TUBERCULOCIDE/VIRUCIDE" "FUNGICIDE/VIRUCIDE" "FUNGICIDE/WOOD-PRESERVATIVE" "FUNGISTAT" "GROWTH-REGULATOR(PGR)" "GROWTH-REGULATOR(PGR)/WOUND-TREATMENT" "GROWTH-REGULATOR/GROWTH-STIMULANT" "GROWTH-REGULATOR/HERBICIDE" "GROWTH-REGULATOR/HERBICIDE/INSECTICIDE" "GROWTH-REGULATOR/INSECTICIDE" "GROWTH-REGULATOR/NEMATICIDE" "GROWTH-REGULATOR/REPELLENT" "GROWTH-REGULATOR/SEED-PROTECTANT" "GROWTH-STIMULANT" "GROWTH-STIMULANT/NEMATICIDE" "HERBICIDE" "HERBICIDE" "HERBICIDE-W/FERTILIZER" "HERBICIDE/INSECTICIDE" "HERBICIDE/INSECTICIDE/ACATICIDE" "HERBICIDE/INSECTICIDE/NEMATICIDE" "HERBICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "HERBICIDE/MICROBIAL-PESTICIDE" "HERBICIDE/REGULATOR" "HERBICIDE/SAFENER" "IMMUNITY-STIMULATOR" "INOCULANT" "INSECT-GROWTH-REGULATOR" "INSECT-GROWTH-REGULATOR/INSECTICIDE" "INSECT-GROWTH-REGULATOR/INSECTICIDE/NEMATICIDE" "INSECT-GROWTH-REGULATOR/INSECTICIDE/REPELLENT" "INSECT-GROWTH-REGULATOR/REPELLENT" "INSECT-GROWTH-REGULATOR/SEX-ATTRACTANT" "INSECT-REPELLENT" "INSECTICIDE" "INSECTICIDE" "INSECTICIDE-SYNERGIST/SAFENER" "INSECTICIDE(MICROBIOLOGICAL)" "INSECTICIDE(SOAP)" "INSECTICIDE(SOAP)/INSECTICIDE" "INSECTICIDE/CRUSTICIDE" "INSECTICIDE/MATING-DISRUPTANT" "INSECTICIDE/MICROBIAL-PESTICIDE" "INSECTICIDE/MOLLUSCICIDE" "INSECTICIDE/MOLLUSCICIDE/REGULATOR/TADPOLE-SH" "INSECTICIDE/MOLLUSCICIDE/TADPOLE-SH" "INSECTICIDE/NEMATICIDE" "INSECTICIDE/NEMATICIDE/REPELLENT" "INSECTICIDE/NEMATICIDE/SEED-TREATMENT" "INSECTICIDE/NEMATICIDE/SEX-ATTRACTANT" "INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "INSECTICIDE/PHEROMONE" "INSECTICIDE/REPELLENT" "INSECTICIDE/RODENTICIDE" "INSECTICIDE/SEED-TREATMENT" "INSECTICIDE/TERMITICIDE" "INSECTICIDE/VERMIN-DESTROYER" "INSECTICIDE/VIRUCIDE" "INSECTICIDE/WOOD-PRESERVATIVE" "LIMACIDE" "LIVING-ORGANISMS" "LIVING-ORGANISMS(AGAINST-FUNGI)" "LIVING-ORGANISMS(AGAINST-FUNGI)/FUNGICIDE" "LIVING-ORGANISMS(BACTERIA)/FUNGICIDE" "LIVING-ORGANISMS(FUNGI)" "LIVING-ORGANISMS(FUNGI)/FUNGICIDE" "LIVING-ORGANISMS(INSECTS)" "LIVING-ORGANISMS(INSECTS)/PRESERVATIVE" "LIVING-ORGANISMS(MITES)" "LIVING-ORGANISMS(NEMATODES)" "LIVING-ORGANISMS(NEMATODES)/INSECTICIDE" "MATING-DISRUPTANT" "MATING-DISRUPTANT/SEX-ATTRACTANT" "MICROBIAL-PESTICIDE" "MICROBIAL-PESTICIDE/MOLLUSCICIDE/TADPOLE-SH" "MICROBIAL-PESTICIDE/NEMATICIDE" "MICROBIAL-PESTICIDE/REGULATOR" "MICROBIAL-PESTICIDE/SEX-ATTRACTANT" "MICRONUTRIENTS" "MISCELLANEOUS" "MOLLUSCICIDE" "MOLLUSCICIDE/REPELLENT" "MOLLUSCICIDE/SLIMICI" "MOLLUSCICIDE/TADPOLE-SH" "NATURAL-DEFENCE-STIMULATOR" "NEMATICIDE" "NEMATICIDE" "NEMATICIDE(MICROBIOLOGICAL)" "NEMATICIDE/REGULATOR" "NEMATICIDE/SEX-ATTRACTANT" "NEMATICIDE/SOIL-FUMIGANT" "NON-PARASITIC-PLANT-DISEASE-CONTROL" "ORGANISMS(INSECT-VIRUSES)" "OTHER" "OTHERS" "PESTICIDE/FERTILIZER" "PHEROMONE" "PHEROMONE-SYNTHETIC" "PHYSICAL-CONTROL-AGENT" "PLANT GROWTH REGULATO" "PLANT-ACTIVATOR" "PRESERVATIVE" "PRESERVATIVE/INSECTICIDE" "PRODUCT-AGAINST-STORAGE-PESTS" "PROTECTANT" "PRUNING-PAINT" "REGULATOR" "REPELLENT" "RODENT/REPELLENT" "RODENTICIDE" "RODENTICIDE" "SAFENER" "SEED TREATMENT" "SEED-PROTECTANT" "SEED-TREATMENT" "SOIL-DISINFECTANT" "SOIL-DISINFECTANT/NEMATICIDE" "SOIL-FUMIGANT" "SOIL-STERILANT" "SPECIAL-PREPARATIONS" "SPORICIDE" "SPORICIDE/VIRUCIDE" "STERILIZING-PLANTING-AGENT" "SULPHUR" "SURFACTANT/FRUIT-COATING" "TALPICIDE" "TANK-MIX" "TECHNICAL" "TERMITICIDE" "TUBERCULOCIDE/VIRUCIDE" "UNSPECIFIED" "VIRUCIDE" "WAX" "WETTING" "WOOD-PRESERVATIVE" "WOUND-TREATMENT"
selling_units
required
string (SellingUnits)
Enum: "KILOGRAMS" "LITERS" "UNITS" "BOXS" "SACK" "GALLONS" "GRAMS" "TONNES" "MILLILITER" "METERS" "OUNCES" "POUNDS" "PINTS" "DOSE" "UNKNOWN"

Responses

Request samples

Content type
application/json
{
  • "name": "Product A",
  • "indication": "ACARICIDE",
  • "selling_units": "LITERS"
}

Response samples

Content type
application/json
{
  • "name": "Product navigate",
  • "indication": "ACARICIDE",
  • "selling_units": "LITERS",
  • "id": "f801e123-206e-4821-8ed0-b6a06fc029cf",
  • "deleted": false,
  • "org_id": "8521b1d2-23c4-4340-bbc8-eb787f0edd4e"
}

Create a Custom Product in the Catalog

Create Catalog Custom Product.

Request Body schema: application/json
name
required
string
org_id
required
string <uuid>
indication
required
string (ProductIndication)
Enum: "ACARICIDE" "ACARICIDE(MICROBIOLOGICAL)" "ACARICIDE/ADHESIVE(SPREADER)/ADJUVANT/INSECTICIDE" "ACARICIDE/ADJUVANT/INSECTICIDE" "ACARICIDE/ADJUVANT/INSECTICIDE/NEMATICIDE" "ACARICIDE/ATTRACTANT/INSECTICIDE" "ACARICIDE/BACTERICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE/INSECTICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE/INSECTICIDE/SEED-TREATMENT" "ACARICIDE/FORMICIDE/INSECTICIDE" "ACARICIDE/FUMIGANT" "ACARICIDE/FUNGICIDE" "ACARICIDE/FUNGICIDE/INSECTICIDE" "ACARICIDE/FUNGICIDE/INSECTICIDE/NEMATICIDE/RODENTICIDE" "ACARICIDE/GROWTH-REGULATOR/INSECTICIDE" "ACARICIDE/HERBICIDE/NEMATICIDE" "ACARICIDE/INSECT-GROWTH-REGULATOR/INSECTICIDE" "ACARICIDE/INSECTICIDE" "ACARICIDE/INSECTICIDE(MICROBIOLOGICAL)" "ACARICIDE/INSECTICIDE/INSECT-REPELLENT/MOLLUSCICIDE" "ACARICIDE/INSECTICIDE/MOLLUSCICIDE" "ACARICIDE/INSECTICIDE/NEMATICIDE" "ACARICIDE/INSECTICIDE/PROD.-AGAINST-STORAGE-PESTS" "ACARICIDE/INSECTICIDE/RODENTICIDE" "ACARICIDE/INSECTICIDE/SEED-PROTECTANT" "ACARICIDE/INSECTICIDE/SEED-TREATMENT" "ACARICIDE/MOLLUSCICIDE/TADPOLE-SH" "ACARICIDE/REPELLENT" "ACRIDICIDE" "ACRIDICIDE/INSECTICIDE" "ACTIVATOR" "ADHESIVE(SPREADER)" "ADHESIVE(SPREADER)/ADJUVANT" "ADHESIVE(SPREADER)/ADJUVANT/FUNGICIDE" "ADJUVANT" "ADJUVANT/ACARICIDE/FUNGICIDE/INSECTICIDE" "ADJUVANT/FUNGICIDE/INSECTICIDE" "ADJUVANT/GROWTH-REGULATOR" "ADJUVANT/HERBICIDE" "ADJUVANT/HERBICIDE/SURFACTANT" "ADJUVANT/INSECTICIDE" "ADJUVANT/SURFACTANT" "ALGAECIDE" "ALGAECIDE/FUNGICIDE" "ALGAECIDE/FUNGICIDE/SLIMICIDE" "ALGAECIDE/HERBICIDE" "ALGAECIDE/HERBICIDE/MOLLUSCICIDE" "ALGAECIDE/SANITIZER/SLIMICIDE/BACTERICIDE" "ALGAECIDE/SLIMICIDE" "ALGICIDE" "ANIMAL-TOXICANT" "ANIMAL-TOXICANT/INSECTICIDE/RODENTICIDE" "ANIMAL-TOXICANT/RODENTICIDE" "ANTI-FOAMING" "ANTI-FOULING-PAINT" "ANTI-MOSS" "ANTI-MOSS/HERBICIDE" "ANTI-SCALD" "ANTI-SPROUTING" "ATTRACTANT" "ATTRACTANT/INSECTICIDE" "AVICIDE" "BACTERICIDE" "BACTERICIDE/DISINFECTANT/FUNGICIDE" "BACTERICIDE/FUMIGANT/FUNGICIDE" "BACTERICIDE/FUNGICIDE" "BACTERICIDE/FUNGICIDE(MICROBIOLOGICAL)" "BACTERICIDE/FUNGICIDE/GROWTH-REGULATOR" "BACTERICIDE/FUNGICIDE/INSECTICIDE" "BACTERICIDE/FUNGICIDE/MOLLUSCICIDE" "BACTERICIDE/FUNGICIDE/NEMATICIDE" "BACTERICIDE/FUNGICIDE/NEMATICIDE/SOIL-DISINFECTANT" "BACTERICIDE/FUNGICIDE/SEED-TREATMENT" "BACTERICIDE/FUNGICIDE/SOIL-DISINFECTANT" "BACTERICIDE/FUNGICIDE/SPORICIDE" "BACTERICIDE/FUNGICIDE/VIRUCIDE" "BACTERICIDE/GROWTH-REGULATOR" "BACTERICIDE/INSECTICIDE" "BACTERICIDE/NEMATICIDE" "BAIT" "BIO-FUNGICIDE" "BIO-INSECTICIDE" "BIO-NEMATICIDE" "BIOCHEMICAL-PESTICIDE" "BIOLOGICAL-CONTROL-AGENT" "BIOLOGICAL-CONTROL-PRODUCT" "BIOLOGICAL-CTRL.-PROD./INSECTICIDE" "BIOLOGICAL-CTRL.-PROD./NEMATICIDE" "BIOLOGICAL-CTRL.-PROD./VIRUCIDE" "BIOSTIMULANT" "BIRD-REPELLENT" "BUFFER-AGENT" "CROP-BACTERICIDE" "CROP-BACTERICIDE/FUNGICIDE" "CROP-BACTERICIDE/FUNGICIDE/HERBICIDE" "CRUSTICIDE" "CRUSTICIDE/MOLLUSCICIDE" "DEFOLIANT" "DEFOLIANT/DESICCANT" "DEFOLIANT/DESICCANT/HERBICIDE" "DEFOLIANT/DESICCANT/REGULATOR" "DEFOLIANT/GROWTH-REGULATOR(PGR)" "DEFOLIANT/HERBICIDE" "DEFOLIANT/HERBICIDE/REGULATOR" "DEFOLIANT/REGULATOR" "DESICCANT" "DESICCANT/HERBICIDE" "DESICCANT/HERBICIDE/REGULATOR" "DESICCANT/MICROBIAL/REGULATOR" "DISINFECTANT" "DISINFECTANT/FUNGICIDE/HERBICIDE/NEMATICIDE" "DISINFECTANT/FUNGICIDE/NEMATICIDE" "DISINFECTANT/INSECTICIDE" "DISINFECTANT/PRESERVATIVE" "DISINFECTANT/SEED-TREATMENT" "ELICITOR" "FERTILIZER/SOIL-CONDITIONER" "FORMICIDE" "FORMICIDE/FUNGICIDE" "FORMICIDE/FUNGICIDE/INSECTICIDE/NEMATICIDE" "FORMICIDE/INSECTICIDE" "FORMICIDE/INSECTICIDE/RODENTICIDE" "FORMICIDE/INSECTICIDE/SEED-TREATMENT" "FORMICIDE/INSECTICIDE/TERMITICIDE" "FUMIGANT" "FUMIGANT/FUNGICIDE" "FUMIGANT/INSECTICIDE" "FUMIGANT/INSECTICIDE/MOLLUSCICIDE/TADPOLE-SH" "FUMIGANT/INSECTICIDE/RODENTICIDE" "FUMIGANT/NEMATICIDE" "FUMIGANT/SEED-TREATMENT" "FUNGICIDE" "FUNGICIDE" "FUNGICIDE(MICROBIOLOGICAL)" "FUNGICIDE/ACARICIDE" "FUNGICIDE/DISINFECTANT/PRESERVATIVE" "FUNGICIDE/GROWTH-REGULATOR" "FUNGICIDE/GROWTH-REGULATOR/HERBICIDE" "FUNGICIDE/GROWTH-REGULATOR/INSECTICIDE" "FUNGICIDE/GROWTH-REGULATOR/SEED-PROTECTANT" "FUNGICIDE/HERBICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE/RODENTICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/INSECTICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/INSECTICIDE/VIRUCIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE/NEMATICIDE/TADPOLE-SH" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE/TADPOLE-SH" "FUNGICIDE/HERBICIDE/NEMATICIDE" "FUNGICIDE/HERBICIDE/NEMATICIDE/SLIMICIDE" "FUNGICIDE/HERBICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/NEMATICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/HERBICIDE/REGULATOR" "FUNGICIDE/HERBICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/INSECT-GROWTH-REGULATOR/INSECTICIDE" "FUNGICIDE/INSECTICIDE" "FUNGICIDE/INSECTICIDE/MICROBIAL" "FUNGICIDE/INSECTICIDE/MICROBIAL/REGULATOR" "FUNGICIDE/INSECTICIDE/MISCELLANEOUS" "FUNGICIDE/INSECTICIDE/MOLLUSCICIDE/NEMATICIDE" "FUNGICIDE/INSECTICIDE/NEMATICIDE" "FUNGICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/INSECTICIDE/REGULATOR" "FUNGICIDE/INSECTICIDE/REPELLENT" "FUNGICIDE/INSECTICIDE/RODENTICIDE" "FUNGICIDE/INSECTICIDE/SEED-PROTECTANT" "FUNGICIDE/INSECTICIDE/SEED-TREATMENT" "FUNGICIDE/INSECTICIDE/VIRUCIDE" "FUNGICIDE/INSECTICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/MATERIAL-PRESERVATIVE" "FUNGICIDE/MICROBIAL" "FUNGICIDE/MICROBIAL/REGULATOR" "FUNGICIDE/MOLLUSCICIDE" "FUNGICIDE/NEMATICIDE" "FUNGICIDE/NEMATICIDE(MICROBIOLOGICAL)" "FUNGICIDE/NEMATICIDE/PLANT-GROWTH-REGULATOR" "FUNGICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/REGULATOR" "FUNGICIDE/REPELLENT" "FUNGICIDE/SANITIZER" "FUNGICIDE/SEED-PROTECTANT" "FUNGICIDE/SEED-TREATMENT" "FUNGICIDE/SEED-TREATMENT/BIO-FERTILIZER" "FUNGICIDE/SPORICIDE/TUBERCULOCIDE/VIRUCIDE" "FUNGICIDE/TUBERCULOCIDE/VIRUCIDE" "FUNGICIDE/VIRUCIDE" "FUNGICIDE/WOOD-PRESERVATIVE" "FUNGISTAT" "GROWTH-REGULATOR(PGR)" "GROWTH-REGULATOR(PGR)/WOUND-TREATMENT" "GROWTH-REGULATOR/GROWTH-STIMULANT" "GROWTH-REGULATOR/HERBICIDE" "GROWTH-REGULATOR/HERBICIDE/INSECTICIDE" "GROWTH-REGULATOR/INSECTICIDE" "GROWTH-REGULATOR/NEMATICIDE" "GROWTH-REGULATOR/REPELLENT" "GROWTH-REGULATOR/SEED-PROTECTANT" "GROWTH-STIMULANT" "GROWTH-STIMULANT/NEMATICIDE" "HERBICIDE" "HERBICIDE" "HERBICIDE-W/FERTILIZER" "HERBICIDE/INSECTICIDE" "HERBICIDE/INSECTICIDE/ACATICIDE" "HERBICIDE/INSECTICIDE/NEMATICIDE" "HERBICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "HERBICIDE/MICROBIAL-PESTICIDE" "HERBICIDE/REGULATOR" "HERBICIDE/SAFENER" "IMMUNITY-STIMULATOR" "INOCULANT" "INSECT-GROWTH-REGULATOR" "INSECT-GROWTH-REGULATOR/INSECTICIDE" "INSECT-GROWTH-REGULATOR/INSECTICIDE/NEMATICIDE" "INSECT-GROWTH-REGULATOR/INSECTICIDE/REPELLENT" "INSECT-GROWTH-REGULATOR/REPELLENT" "INSECT-GROWTH-REGULATOR/SEX-ATTRACTANT" "INSECT-REPELLENT" "INSECTICIDE" "INSECTICIDE" "INSECTICIDE-SYNERGIST/SAFENER" "INSECTICIDE(MICROBIOLOGICAL)" "INSECTICIDE(SOAP)" "INSECTICIDE(SOAP)/INSECTICIDE" "INSECTICIDE/CRUSTICIDE" "INSECTICIDE/MATING-DISRUPTANT" "INSECTICIDE/MICROBIAL-PESTICIDE" "INSECTICIDE/MOLLUSCICIDE" "INSECTICIDE/MOLLUSCICIDE/REGULATOR/TADPOLE-SH" "INSECTICIDE/MOLLUSCICIDE/TADPOLE-SH" "INSECTICIDE/NEMATICIDE" "INSECTICIDE/NEMATICIDE/REPELLENT" "INSECTICIDE/NEMATICIDE/SEED-TREATMENT" "INSECTICIDE/NEMATICIDE/SEX-ATTRACTANT" "INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "INSECTICIDE/PHEROMONE" "INSECTICIDE/REPELLENT" "INSECTICIDE/RODENTICIDE" "INSECTICIDE/SEED-TREATMENT" "INSECTICIDE/TERMITICIDE" "INSECTICIDE/VERMIN-DESTROYER" "INSECTICIDE/VIRUCIDE" "INSECTICIDE/WOOD-PRESERVATIVE" "LIMACIDE" "LIVING-ORGANISMS" "LIVING-ORGANISMS(AGAINST-FUNGI)" "LIVING-ORGANISMS(AGAINST-FUNGI)/FUNGICIDE" "LIVING-ORGANISMS(BACTERIA)/FUNGICIDE" "LIVING-ORGANISMS(FUNGI)" "LIVING-ORGANISMS(FUNGI)/FUNGICIDE" "LIVING-ORGANISMS(INSECTS)" "LIVING-ORGANISMS(INSECTS)/PRESERVATIVE" "LIVING-ORGANISMS(MITES)" "LIVING-ORGANISMS(NEMATODES)" "LIVING-ORGANISMS(NEMATODES)/INSECTICIDE" "MATING-DISRUPTANT" "MATING-DISRUPTANT/SEX-ATTRACTANT" "MICROBIAL-PESTICIDE" "MICROBIAL-PESTICIDE/MOLLUSCICIDE/TADPOLE-SH" "MICROBIAL-PESTICIDE/NEMATICIDE" "MICROBIAL-PESTICIDE/REGULATOR" "MICROBIAL-PESTICIDE/SEX-ATTRACTANT" "MICRONUTRIENTS" "MISCELLANEOUS" "MOLLUSCICIDE" "MOLLUSCICIDE/REPELLENT" "MOLLUSCICIDE/SLIMICI" "MOLLUSCICIDE/TADPOLE-SH" "NATURAL-DEFENCE-STIMULATOR" "NEMATICIDE" "NEMATICIDE" "NEMATICIDE(MICROBIOLOGICAL)" "NEMATICIDE/REGULATOR" "NEMATICIDE/SEX-ATTRACTANT" "NEMATICIDE/SOIL-FUMIGANT" "NON-PARASITIC-PLANT-DISEASE-CONTROL" "ORGANISMS(INSECT-VIRUSES)" "OTHER" "OTHERS" "PESTICIDE/FERTILIZER" "PHEROMONE" "PHEROMONE-SYNTHETIC" "PHYSICAL-CONTROL-AGENT" "PLANT GROWTH REGULATO" "PLANT-ACTIVATOR" "PRESERVATIVE" "PRESERVATIVE/INSECTICIDE" "PRODUCT-AGAINST-STORAGE-PESTS" "PROTECTANT" "PRUNING-PAINT" "REGULATOR" "REPELLENT" "RODENT/REPELLENT" "RODENTICIDE" "RODENTICIDE" "SAFENER" "SEED TREATMENT" "SEED-PROTECTANT" "SEED-TREATMENT" "SOIL-DISINFECTANT" "SOIL-DISINFECTANT/NEMATICIDE" "SOIL-FUMIGANT" "SOIL-STERILANT" "SPECIAL-PREPARATIONS" "SPORICIDE" "SPORICIDE/VIRUCIDE" "STERILIZING-PLANTING-AGENT" "SULPHUR" "SURFACTANT/FRUIT-COATING" "TALPICIDE" "TANK-MIX" "TECHNICAL" "TERMITICIDE" "TUBERCULOCIDE/VIRUCIDE" "UNSPECIFIED" "VIRUCIDE" "WAX" "WETTING" "WOOD-PRESERVATIVE" "WOUND-TREATMENT"
selling_units
required
string (SellingUnits)
Enum: "KILOGRAMS" "LITERS" "UNITS" "BOXS" "SACK" "GALLONS" "GRAMS" "TONNES" "MILLILITER" "METERS" "OUNCES" "POUNDS" "PINTS" "DOSE" "UNKNOWN"

Responses

Request samples

Content type
application/json
{
  • "name": "Product A",
  • "org_id": "8521b1d2-23c4-4340-bbc8-eb787f0edd4e",
  • "indication": "ACARICIDE",
  • "selling_units": "LITERS"
}

Response samples

Content type
application/json
{
  • "name": "Product navigate",
  • "indication": "ACARICIDE",
  • "selling_units": "LITERS",
  • "id": "f801e123-206e-4821-8ed0-b6a06fc029cf",
  • "deleted": false,
  • "org_id": "8521b1d2-23c4-4340-bbc8-eb787f0edd4e"
}

Get Canon Products in the Catalog

Get Catalog Canon Product-country-source.

query Parameters
full
boolean

If all product's attributes will be returned or not. Default is false.

include_deleted
boolean

If deleted products will be returned or not. Default is false

include_attributes
Array of strings

Which attributes will be included in the response. They will appear only if they do exist.

indication
string (ProductIndication)
Enum: "ACARICIDE" "ACARICIDE(MICROBIOLOGICAL)" "ACARICIDE/ADHESIVE(SPREADER)/ADJUVANT/INSECTICIDE" "ACARICIDE/ADJUVANT/INSECTICIDE" "ACARICIDE/ADJUVANT/INSECTICIDE/NEMATICIDE" "ACARICIDE/ATTRACTANT/INSECTICIDE" "ACARICIDE/BACTERICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE/INSECTICIDE" "ACARICIDE/BACTERICIDE/FUNGICIDE/INSECTICIDE/SEED-TREATMENT" "ACARICIDE/FORMICIDE/INSECTICIDE" "ACARICIDE/FUMIGANT" "ACARICIDE/FUNGICIDE" "ACARICIDE/FUNGICIDE/INSECTICIDE" "ACARICIDE/FUNGICIDE/INSECTICIDE/NEMATICIDE/RODENTICIDE" "ACARICIDE/GROWTH-REGULATOR/INSECTICIDE" "ACARICIDE/HERBICIDE/NEMATICIDE" "ACARICIDE/INSECT-GROWTH-REGULATOR/INSECTICIDE" "ACARICIDE/INSECTICIDE" "ACARICIDE/INSECTICIDE(MICROBIOLOGICAL)" "ACARICIDE/INSECTICIDE/INSECT-REPELLENT/MOLLUSCICIDE" "ACARICIDE/INSECTICIDE/MOLLUSCICIDE" "ACARICIDE/INSECTICIDE/NEMATICIDE" "ACARICIDE/INSECTICIDE/PROD.-AGAINST-STORAGE-PESTS" "ACARICIDE/INSECTICIDE/RODENTICIDE" "ACARICIDE/INSECTICIDE/SEED-PROTECTANT" "ACARICIDE/INSECTICIDE/SEED-TREATMENT" "ACARICIDE/MOLLUSCICIDE/TADPOLE-SH" "ACARICIDE/REPELLENT" "ACRIDICIDE" "ACRIDICIDE/INSECTICIDE" "ACTIVATOR" "ADHESIVE(SPREADER)" "ADHESIVE(SPREADER)/ADJUVANT" "ADHESIVE(SPREADER)/ADJUVANT/FUNGICIDE" "ADJUVANT" "ADJUVANT/ACARICIDE/FUNGICIDE/INSECTICIDE" "ADJUVANT/FUNGICIDE/INSECTICIDE" "ADJUVANT/GROWTH-REGULATOR" "ADJUVANT/HERBICIDE" "ADJUVANT/HERBICIDE/SURFACTANT" "ADJUVANT/INSECTICIDE" "ADJUVANT/SURFACTANT" "ALGAECIDE" "ALGAECIDE/FUNGICIDE" "ALGAECIDE/FUNGICIDE/SLIMICIDE" "ALGAECIDE/HERBICIDE" "ALGAECIDE/HERBICIDE/MOLLUSCICIDE" "ALGAECIDE/SANITIZER/SLIMICIDE/BACTERICIDE" "ALGAECIDE/SLIMICIDE" "ALGICIDE" "ANIMAL-TOXICANT" "ANIMAL-TOXICANT/INSECTICIDE/RODENTICIDE" "ANIMAL-TOXICANT/RODENTICIDE" "ANTI-FOAMING" "ANTI-FOULING-PAINT" "ANTI-MOSS" "ANTI-MOSS/HERBICIDE" "ANTI-SCALD" "ANTI-SPROUTING" "ATTRACTANT" "ATTRACTANT/INSECTICIDE" "AVICIDE" "BACTERICIDE" "BACTERICIDE/DISINFECTANT/FUNGICIDE" "BACTERICIDE/FUMIGANT/FUNGICIDE" "BACTERICIDE/FUNGICIDE" "BACTERICIDE/FUNGICIDE(MICROBIOLOGICAL)" "BACTERICIDE/FUNGICIDE/GROWTH-REGULATOR" "BACTERICIDE/FUNGICIDE/INSECTICIDE" "BACTERICIDE/FUNGICIDE/MOLLUSCICIDE" "BACTERICIDE/FUNGICIDE/NEMATICIDE" "BACTERICIDE/FUNGICIDE/NEMATICIDE/SOIL-DISINFECTANT" "BACTERICIDE/FUNGICIDE/SEED-TREATMENT" "BACTERICIDE/FUNGICIDE/SOIL-DISINFECTANT" "BACTERICIDE/FUNGICIDE/SPORICIDE" "BACTERICIDE/FUNGICIDE/VIRUCIDE" "BACTERICIDE/GROWTH-REGULATOR" "BACTERICIDE/INSECTICIDE" "BACTERICIDE/NEMATICIDE" "BAIT" "BIO-FUNGICIDE" "BIO-INSECTICIDE" "BIO-NEMATICIDE" "BIOCHEMICAL-PESTICIDE" "BIOLOGICAL-CONTROL-AGENT" "BIOLOGICAL-CONTROL-PRODUCT" "BIOLOGICAL-CTRL.-PROD./INSECTICIDE" "BIOLOGICAL-CTRL.-PROD./NEMATICIDE" "BIOLOGICAL-CTRL.-PROD./VIRUCIDE" "BIOSTIMULANT" "BIRD-REPELLENT" "BUFFER-AGENT" "CROP-BACTERICIDE" "CROP-BACTERICIDE/FUNGICIDE" "CROP-BACTERICIDE/FUNGICIDE/HERBICIDE" "CRUSTICIDE" "CRUSTICIDE/MOLLUSCICIDE" "DEFOLIANT" "DEFOLIANT/DESICCANT" "DEFOLIANT/DESICCANT/HERBICIDE" "DEFOLIANT/DESICCANT/REGULATOR" "DEFOLIANT/GROWTH-REGULATOR(PGR)" "DEFOLIANT/HERBICIDE" "DEFOLIANT/HERBICIDE/REGULATOR" "DEFOLIANT/REGULATOR" "DESICCANT" "DESICCANT/HERBICIDE" "DESICCANT/HERBICIDE/REGULATOR" "DESICCANT/MICROBIAL/REGULATOR" "DISINFECTANT" "DISINFECTANT/FUNGICIDE/HERBICIDE/NEMATICIDE" "DISINFECTANT/FUNGICIDE/NEMATICIDE" "DISINFECTANT/INSECTICIDE" "DISINFECTANT/PRESERVATIVE" "DISINFECTANT/SEED-TREATMENT" "ELICITOR" "FERTILIZER/SOIL-CONDITIONER" "FORMICIDE" "FORMICIDE/FUNGICIDE" "FORMICIDE/FUNGICIDE/INSECTICIDE/NEMATICIDE" "FORMICIDE/INSECTICIDE" "FORMICIDE/INSECTICIDE/RODENTICIDE" "FORMICIDE/INSECTICIDE/SEED-TREATMENT" "FORMICIDE/INSECTICIDE/TERMITICIDE" "FUMIGANT" "FUMIGANT/FUNGICIDE" "FUMIGANT/INSECTICIDE" "FUMIGANT/INSECTICIDE/MOLLUSCICIDE/TADPOLE-SH" "FUMIGANT/INSECTICIDE/RODENTICIDE" "FUMIGANT/NEMATICIDE" "FUMIGANT/SEED-TREATMENT" "FUNGICIDE" "FUNGICIDE" "FUNGICIDE(MICROBIOLOGICAL)" "FUNGICIDE/ACARICIDE" "FUNGICIDE/DISINFECTANT/PRESERVATIVE" "FUNGICIDE/GROWTH-REGULATOR" "FUNGICIDE/GROWTH-REGULATOR/HERBICIDE" "FUNGICIDE/GROWTH-REGULATOR/INSECTICIDE" "FUNGICIDE/GROWTH-REGULATOR/SEED-PROTECTANT" "FUNGICIDE/HERBICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE/RODENTICIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/INSECTICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/INSECTICIDE/VIRUCIDE" "FUNGICIDE/HERBICIDE/INSECTICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE/NEMATICIDE/TADPOLE-SH" "FUNGICIDE/HERBICIDE/MOLLUSCICIDE/TADPOLE-SH" "FUNGICIDE/HERBICIDE/NEMATICIDE" "FUNGICIDE/HERBICIDE/NEMATICIDE/SLIMICIDE" "FUNGICIDE/HERBICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/HERBICIDE/NEMATICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/HERBICIDE/REGULATOR" "FUNGICIDE/HERBICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/INSECT-GROWTH-REGULATOR/INSECTICIDE" "FUNGICIDE/INSECTICIDE" "FUNGICIDE/INSECTICIDE/MICROBIAL" "FUNGICIDE/INSECTICIDE/MICROBIAL/REGULATOR" "FUNGICIDE/INSECTICIDE/MISCELLANEOUS" "FUNGICIDE/INSECTICIDE/MOLLUSCICIDE/NEMATICIDE" "FUNGICIDE/INSECTICIDE/NEMATICIDE" "FUNGICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/INSECTICIDE/REGULATOR" "FUNGICIDE/INSECTICIDE/REPELLENT" "FUNGICIDE/INSECTICIDE/RODENTICIDE" "FUNGICIDE/INSECTICIDE/SEED-PROTECTANT" "FUNGICIDE/INSECTICIDE/SEED-TREATMENT" "FUNGICIDE/INSECTICIDE/VIRUCIDE" "FUNGICIDE/INSECTICIDE/WOOD-PRESERVATIVE" "FUNGICIDE/MATERIAL-PRESERVATIVE" "FUNGICIDE/MICROBIAL" "FUNGICIDE/MICROBIAL/REGULATOR" "FUNGICIDE/MOLLUSCICIDE" "FUNGICIDE/NEMATICIDE" "FUNGICIDE/NEMATICIDE(MICROBIOLOGICAL)" "FUNGICIDE/NEMATICIDE/PLANT-GROWTH-REGULATOR" "FUNGICIDE/NEMATICIDE/SOIL-FUMIGANT" "FUNGICIDE/REGULATOR" "FUNGICIDE/REPELLENT" "FUNGICIDE/SANITIZER" "FUNGICIDE/SEED-PROTECTANT" "FUNGICIDE/SEED-TREATMENT" "FUNGICIDE/SEED-TREATMENT/BIO-FERTILIZER" "FUNGICIDE/SPORICIDE/TUBERCULOCIDE/VIRUCIDE" "FUNGICIDE/TUBERCULOCIDE/VIRUCIDE" "FUNGICIDE/VIRUCIDE" "FUNGICIDE/WOOD-PRESERVATIVE" "FUNGISTAT" "GROWTH-REGULATOR(PGR)" "GROWTH-REGULATOR(PGR)/WOUND-TREATMENT" "GROWTH-REGULATOR/GROWTH-STIMULANT" "GROWTH-REGULATOR/HERBICIDE" "GROWTH-REGULATOR/HERBICIDE/INSECTICIDE" "GROWTH-REGULATOR/INSECTICIDE" "GROWTH-REGULATOR/NEMATICIDE" "GROWTH-REGULATOR/REPELLENT" "GROWTH-REGULATOR/SEED-PROTECTANT" "GROWTH-STIMULANT" "GROWTH-STIMULANT/NEMATICIDE" "HERBICIDE" "HERBICIDE" "HERBICIDE-W/FERTILIZER" "HERBICIDE/INSECTICIDE" "HERBICIDE/INSECTICIDE/ACATICIDE" "HERBICIDE/INSECTICIDE/NEMATICIDE" "HERBICIDE/INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "HERBICIDE/MICROBIAL-PESTICIDE" "HERBICIDE/REGULATOR" "HERBICIDE/SAFENER" "IMMUNITY-STIMULATOR" "INOCULANT" "INSECT-GROWTH-REGULATOR" "INSECT-GROWTH-REGULATOR/INSECTICIDE" "INSECT-GROWTH-REGULATOR/INSECTICIDE/NEMATICIDE" "INSECT-GROWTH-REGULATOR/INSECTICIDE/REPELLENT" "INSECT-GROWTH-REGULATOR/REPELLENT" "INSECT-GROWTH-REGULATOR/SEX-ATTRACTANT" "INSECT-REPELLENT" "INSECTICIDE" "INSECTICIDE" "INSECTICIDE-SYNERGIST/SAFENER" "INSECTICIDE(MICROBIOLOGICAL)" "INSECTICIDE(SOAP)" "INSECTICIDE(SOAP)/INSECTICIDE" "INSECTICIDE/CRUSTICIDE" "INSECTICIDE/MATING-DISRUPTANT" "INSECTICIDE/MICROBIAL-PESTICIDE" "INSECTICIDE/MOLLUSCICIDE" "INSECTICIDE/MOLLUSCICIDE/REGULATOR/TADPOLE-SH" "INSECTICIDE/MOLLUSCICIDE/TADPOLE-SH" "INSECTICIDE/NEMATICIDE" "INSECTICIDE/NEMATICIDE/REPELLENT" "INSECTICIDE/NEMATICIDE/SEED-TREATMENT" "INSECTICIDE/NEMATICIDE/SEX-ATTRACTANT" "INSECTICIDE/NEMATICIDE/SOIL-FUMIGANT" "INSECTICIDE/PHEROMONE" "INSECTICIDE/REPELLENT" "INSECTICIDE/RODENTICIDE" "INSECTICIDE/SEED-TREATMENT" "INSECTICIDE/TERMITICIDE" "INSECTICIDE/VERMIN-DESTROYER" "INSECTICIDE/VIRUCIDE" "INSECTICIDE/WOOD-PRESERVATIVE" "LIMACIDE" "LIVING-ORGANISMS" "LIVING-ORGANISMS(AGAINST-FUNGI)" "LIVING-ORGANISMS(AGAINST-FUNGI)/FUNGICIDE" "LIVING-ORGANISMS(BACTERIA)/FUNGICIDE" "LIVING-ORGANISMS(FUNGI)" "LIVING-ORGANISMS(FUNGI)/FUNGICIDE" "LIVING-ORGANISMS(INSECTS)" "LIVING-ORGANISMS(INSECTS)/PRESERVATIVE" "LIVING-ORGANISMS(MITES)" "LIVING-ORGANISMS(NEMATODES)" "LIVING-ORGANISMS(NEMATODES)/INSECTICIDE" "MATING-DISRUPTANT" "MATING-DISRUPTANT/SEX-ATTRACTANT" "MICROBIAL-PESTICIDE" "MICROBIAL-PESTICIDE/MOLLUSCICIDE/TADPOLE-SH" "MICROBIAL-PESTICIDE/NEMATICIDE" "MICROBIAL-PESTICIDE/REGULATOR" "MICROBIAL-PESTICIDE/SEX-ATTRACTANT" "MICRONUTRIENTS" "MISCELLANEOUS" "MOLLUSCICIDE" "MOLLUSCICIDE/REPELLENT" "MOLLUSCICIDE/SLIMICI" "MOLLUSCICIDE/TADPOLE-SH" "NATURAL-DEFENCE-STIMULATOR" "NEMATICIDE" "NEMATICIDE" "NEMATICIDE(MICROBIOLOGICAL)" "NEMATICIDE/REGULATOR" "NEMATICIDE/SEX-ATTRACTANT" "NEMATICIDE/SOIL-FUMIGANT" "NON-PARASITIC-PLANT-DISEASE-CONTROL" "ORGANISMS(INSECT-VIRUSES)" "OTHER" "OTHERS" "PESTICIDE/FERTILIZER" "PHEROMONE" "PHEROMONE-SYNTHETIC" "PHYSICAL-CONTROL-AGENT" "PLANT GROWTH REGULATO" "PLANT-ACTIVATOR" "PRESERVATIVE" "PRESERVATIVE/INSECTICIDE" "PRODUCT-AGAINST-STORAGE-PESTS" "PROTECTANT" "PRUNING-PAINT" "REGULATOR" "REPELLENT" "RODENT/REPELLENT" "RODENTICIDE" "RODENTICIDE" "SAFENER" "SEED TREATMENT" "SEED-PROTECTANT" "SEED-TREATMENT" "SOIL-DISINFECTANT" "SOIL-DISINFECTANT/NEMATICIDE" "SOIL-FUMIGANT" "SOIL-STERILANT" "SPECIAL-PREPARATIONS" "SPORICIDE" "SPORICIDE/VIRUCIDE" "STERILIZING-PLANTING-AGENT" "SULPHUR" "SURFACTANT/FRUIT-COATING" "TALPICIDE" "TANK-MIX" "TECHNICAL" "TERMITICIDE" "TUBERCULOCIDE/VIRUCIDE" "UNSPECIFIED" "VIRUCIDE" "WAX" "WETTING" "WOOD-PRESERVATIVE" "WOUND-TREATMENT"

Requested product's type.

country
required
string

Requested country

source
string

Requested sourece. Default is TUBE

name
string

Requested product's name. Search by "begins_with" and insensitive case.

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "number_of_elements": 2,
  • "last": true,
  • "first": true,
  • "empty": false
}

Commons

Common models to multiple parts of the API

Contracts

Contracts listing, editing and creation

Get all contracts for an app

Get all contracts for an app

path Parameters
appId
required
string

Numeric ID of the App

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get contracts by entitlements ids

query Parameters
contains
string
Enum: "ALL_ENTITLEMENTS" "SOME_ENTITLEMENTS"

If a contract must have all entitlement's keys or just some of them. Default is SOME_ENTITLEMENTS

include_deleted
boolean

If deleted contracts will be retrieved as well. Default is FALSE

last_key
string
size
integer
Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get contracts by entitlements keys

query Parameters
contains
string
Enum: "ALL_ENTITLEMENTS" "SOME_ENTITLEMENTS"

If a contract must have all entitlement's keys or just some of them. Default is SOME_ENTITLEMENTS

include_deleted
boolean

If deleted contracts will be retrieved as well. Default is FALSE

last_key
string
size
integer
Request Body schema: application/json
keys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "keys": [
    ]
}

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get contracts by entitlements

query Parameters
entitlements
Array of strings
shouldContractHaveAllEntitlements
boolean
shouldConsiderDeletedContracts
boolean
lastKey
string
lastKeyComplement
integer

Responses

Response samples

Content type
application/json
{
  • "contracts": [
    ],
  • "lastKey": {
    }
}

Delete Contract

Delete a Contract

path Parameters
workspaceId
required
string

Numeric ID of the account

contractId
required
string

Numeric ID of the contract

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Update a Contract

Update a Contract

path Parameters
workspaceId
required
string

Numeric ID of the account

contractId
required
string

Numeric ID of the contract

Request Body schema: application/json
end
string
Array of objects (EntitlementsList)
start
string
plan
string
plan_name
string
notes
string
licensing_account_id
string

this field is the workspace id of the user

workspace_id
string

this field is the workspace id of the user

Array of objects (Quota)

Responses

Request samples

Content type
application/json
{
  • "end": "string",
  • "entitlements": [
    ],
  • "start": "string",
  • "plan": "string",
  • "plan_name": "string",
  • "notes": "string",
  • "licensing_account_id": "string",
  • "workspace_id": "string",
  • "quotas": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "end": "string",
  • "entitlements": [
    ],
  • "start": "string",
  • "plan": "string",
  • "plan_name": "string",
  • "notes": "string",
  • "licensing_account_id": "string",
  • "workspace_id": "string",
  • "quotas": [
    ]
}

Get a Contract

Get a Contract

path Parameters
workspaceId
required
string

Numeric ID of the account

contractId
required
string

Numeric ID of the contract

Responses

Response samples

Content type
application/json
application/json
application/xml
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "end": "string",
  • "entitlements": [
    ],
  • "start": "string",
  • "plan": "string",
  • "plan_name": "string",
  • "notes": "string",
  • "licensing_account_id": "string",
  • "workspace_id": "string",
  • "quotas": [
    ]
}

Delete contract entities

Delete a Contract Entity

path Parameters
workspaceId
required
string

Numeric ID of the account

contractId
required
string

Numeric ID of the contract

Request Body schema: application/json
Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "end": "string",
  • "entitlements": [
    ],
  • "start": "string",
  • "plan": "string",
  • "plan_name": "string",
  • "notes": "string",
  • "licensing_account_id": "string",
  • "workspace_id": "string",
  • "quotas": [
    ]
}

Update a Contract Entity

Update a Contract Entity

path Parameters
workspaceId
required
string

Numeric ID of the account

contractId
required
string

Numeric ID of the contract

Request Body schema: application/json
quota
string
Array of objects (Entities)

Responses

Request samples

Content type
application/json
{
  • "quota": "string",
  • "entities": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "end": "string",
  • "entitlements": [
    ],
  • "start": "string",
  • "plan": "string",
  • "plan_name": "string",
  • "notes": "string",
  • "licensing_account_id": "string",
  • "workspace_id": "string",
  • "quotas": [
    ]
}

Get Contracts By Account

Get all contracts from a workspace

path Parameters
workspaceId
required
string

Numeric ID of the account to get

query Parameters
size
integer

Number of contracts to return

last_key
string

Id of the last contract returned by the previous query

include_waiting_for_payment
boolean

Allow that contracts that are waiting for payment are also displayed

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Add Contract to Account

Add a contract to a workspace

path Parameters
workspaceId
required
string

Numeric ID of the account to get

Request Body schema: application/json
end
required
string
Array of objects (EntitlementsList)
start
required
string
plan
required
string
Array of objects (Quota)
plan_name
string

Responses

Request samples

Content type
application/json
{
  • "end": "string",
  • "entitlements": [
    ],
  • "start": "string",
  • "plan": "string",
  • "quota": [
    ],
  • "plan_name": "string"
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "end": "string",
  • "entitlements": [
    ],
  • "start": "string",
  • "plan": "string",
  • "plan_name": "string",
  • "notes": "string",
  • "licensing_account_id": "string",
  • "workspace_id": "string",
  • "quotas": [
    ]
}

Get contracts by entity

Get contracts related to an entity

path Parameters
workspaceId
required
string

Numeric ID of the account to get

entityId
required
string

ID of the entity

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Crop

Crop listing

List crops

List Crops

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

header Parameters
Accept-Language
string

Crop names will be responded in the chosen language

Responses

Response samples

Content type
application/json
{
  • "content": [],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Cycle

Cycle listing, editing and creation

Get Cycle's season-fields

Get Cycle's Season-fields

path Parameters
cycleId
required
string

Cycle ID.

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Cycle's season

Get Cycle's Seasons

path Parameters
cycleId
required
string

Cycle ID.

query Parameters
include_deleted
boolean

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Attach/Deattach Cycle's season

Attach/Deattach Cycle's season

path Parameters
cycleId
required
string

Cycle ID.

Request Body schema: application/json
required
Array of objects (OperationAttachSeasonDTO)

Responses

Request samples

Content type
application/json
{
  • "updates": [
    ]
}

Response samples

Content type
application/json
{
  • "accepted_seasons": [
    ],
  • "refused_seasons": [
    ]
}

Get a Cycle

Get a Cycle

path Parameters
cycleId
required
string

Cycle ID.

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-02-07T12:27:01.893+0000",
  • "updated_at": "2023-02-07T12:27:01.893+0000",
  • "org_id": "86d72961-803a-4505-94e2-c9e39fe14380",
  • "name": "CycleDTO Example",
  • "start_at": "2022-02-28T15:26:02.135+0000",
  • "end_at": "2030-02-28T15:26:02.135+0000",
  • "deleted": false,
  • "id": "e55a7708-e42b-442d-9aea-cad5de550629"
}

Delete a Cycle

Delete a Cycle

path Parameters
cycleId
required
string

Cycle ID.

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Edit a Cycle

Edit a Cycle

path Parameters
cycleId
required
string

Cycle ID.

Request Body schema: application/json

Edit cycle's details

name
required
string
start_at
required
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
end_at
required
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Request samples

Content type
application/json
{
  • "name": "CraateCycleDTO Example",
  • "start_at": "2022-02-28T15:26:02.135+0000",
  • "end_at": "2030-02-28T15:26:02.135+0000"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-02-07T12:27:01.893+0000",
  • "updated_at": "2023-02-07T12:27:01.893+0000",
  • "org_id": "86d72961-803a-4505-94e2-c9e39fe14380",
  • "name": "CycleDTO Example",
  • "start_at": "2022-02-28T15:26:02.135+0000",
  • "end_at": "2030-02-28T15:26:02.135+0000",
  • "deleted": false,
  • "id": "e55a7708-e42b-442d-9aea-cad5de550629"
}

Create a Cycle

Create a Cycle

Request Body schema: application/json

Created cycle's details

org_id
required
string <uuid>
name
required
string
start_at
required
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
end_at
required
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "org_id": "86d72961-803a-4505-94e2-c9e39fe14380",
  • "name": "CraateCycleDTO Example",
  • "start_at": "2022-02-28T15:26:02.135+0000",
  • "end_at": "2030-02-28T15:26:02.135+0000"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-02-07T12:27:01.893+0000",
  • "updated_at": "2023-02-07T12:27:01.893+0000",
  • "org_id": "86d72961-803a-4505-94e2-c9e39fe14380",
  • "name": "CycleDTO Example",
  • "start_at": "2022-02-28T15:26:02.135+0000",
  • "end_at": "2030-02-28T15:26:02.135+0000",
  • "deleted": false,
  • "id": "e55a7708-e42b-442d-9aea-cad5de550629"
}

List Organization's Cycles

Gets all cycles of an Organization

path Parameters
orgId
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

List Property's Cycles

Gets all cycles of an Property

path Parameters
propertyId
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

EmailTemplate

Email templates

Upload attachment

Uploads attachment to be used in custom template.

Request Body schema: multipart/form-data

Multipart Form including the attachment file

file
string <binary>

Responses

Response samples

Content type
application/json
{}

Remove attachment

Removes the attachment.

query Parameters
key
required
string

Responses

Upload image

Uploads image to be used in custom template.

Request Body schema: multipart/form-data

Multipart Form including the image file

file
string <binary>

Responses

Response samples

Content type
application/json
{}

Remove image

Removes the image.

query Parameters
key
required
string

Responses

send email

send email with custom placeholders.

path Parameters
template_id
required
string

Template ID.

Request Body schema: application/json
email
required
string
emails
Array of strings
placeholders
object
attachments
Array of strings
cc_emails
Array of strings
sender
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "emails": [
    ],
  • "placeholders": { },
  • "attachments": [
    ],
  • "cc_emails": [
    ],
  • "sender": "string"
}

Delete an EmailTemplate

Delete the specified EmailTemplate.

path Parameters
template_id
required
string

Template ID.

Responses

Edit EmailTemplate

Edits an existing EmailTemplate with the specified id.

path Parameters
template_id
required
string

Template ID.

Request Body schema: application/json
language
required
string
subject
required
string
html_content
required
string
branding
required
string
type
required
string
version
required
string
app_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Request samples

Content type
application/json
{
  • "language": "en",
  • "subject": "Invitation email",
  • "html_content": "Welcome to Cropwsie",
  • "branding": "Syngenta",
  • "type": "invite",
  • "version": "v2"
}

Response samples

Content type
application/json
{
  • "language": "string",
  • "subject": "string",
  • "html_content": "string",
  • "branding": "string",
  • "type": "string",
  • "version": "string",
  • "app_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

EmailTemplate Details

Gets the specified EmailTemplate details.

path Parameters
template_id
required
string

Template ID.

Responses

Response samples

Content type
application/json
{
  • "language": "en",
  • "subject": "Invitation email",
  • "html_content": "Welcome to Cropwsie",
  • "branding": "Syngenta",
  • "type": "invite",
  • "version": "v2",
  • "deleted": false,
  • "id": "384f0b5f-25a5-4102-85ca-7c4fa43a7832"
}

EmailTemplate

Create EmailTemplate

Request Body schema: application/json
language
required
string
subject
required
string
html_content
required
string
branding
required
string
type
required
string
version
required
string
app_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Request samples

Content type
application/json
{
  • "language": "string",
  • "subject": "string",
  • "html_content": "string",
  • "branding": "string",
  • "type": "string",
  • "version": "string",
  • "app_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Response samples

Content type
application/json
{
  • "language": "en",
  • "subject": "Invitation email",
  • "html_content": "Welcome to Cropwsie",
  • "branding": "Syngenta",
  • "type": "invite",
  • "version": "v2"
}

Entitlements

Entitlement listing, editing and creation

Get an Entitlements From an App

Get an Entitlements From an App

path Parameters
appId
required
string

Numeric ID of the App

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get an Entitlement

Get an Entitlement

path Parameters
entitlementId
required
string

Numeric ID of the Entitlement

Responses

Response samples

Content type
application/json
{
  • "app_id": "string",
  • "key": "string",
  • "name": "string",
  • "created_by": "string",
  • "updated_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted": true
}

Soft Delete a Entitlement

Delete an Entitlement

path Parameters
entitlementId
required
string

Numeric ID of the Entitlement to remove

Responses

Response samples

Content type
application/json
{
  • "message": "term deleted successfully"
}

Edit Entitlement

Updates a single entitlement

path Parameters
entitlementId
required
string

Numeric ID of the entitlement to update

Request Body schema: application/json
key
string
name
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "app_id": "string",
  • "key": "string",
  • "name": "string",
  • "created_by": "string",
  • "updated_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted": true
}

Get contracts by entitlements ids

query Parameters
contains
string
Enum: "ALL_ENTITLEMENTS" "SOME_ENTITLEMENTS"

If a contract must have all entitlement's keys or just some of them. Default is SOME_ENTITLEMENTS

include_deleted
boolean

If deleted contracts will be retrieved as well. Default is FALSE

last_key
string
size
integer
Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Entitlements by Ids

Get an Entitlements By Ids

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get contracts by entitlements keys

query Parameters
contains
string
Enum: "ALL_ENTITLEMENTS" "SOME_ENTITLEMENTS"

If a contract must have all entitlement's keys or just some of them. Default is SOME_ENTITLEMENTS

include_deleted
boolean

If deleted contracts will be retrieved as well. Default is FALSE

last_key
string
size
integer
Request Body schema: application/json
keys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "keys": [
    ]
}

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Create a Entitlement

Creates a new Entitlement

Request Body schema: application/json
app_id
required
string
key
required
string
value
required
string

Responses

Request samples

Content type
application/json
{
  • "app_id": "string",
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "app_id": "string",
  • "key": "string",
  • "name": "string",
  • "created_by": "string",
  • "updated_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted": true
}

Get contracts by entitlements

query Parameters
entitlements
Array of strings
shouldContractHaveAllEntitlements
boolean
shouldConsiderDeletedContracts
boolean
lastKey
string
lastKeyComplement
integer

Responses

Response samples

Content type
application/json
{
  • "contracts": [
    ],
  • "lastKey": {
    }
}

Equipment

Equipment listing, editing and creation

List Equipment By ID

List Equipment

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "Name",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "type": "VEHICLE",
  • "id": "002f4753-5c5b-5dbd-8ed6-f0a83f86090d",
  • "property_ids": [
    ],
  • "label": "TRUCK",
  • "licensing_number": "string",
  • "unit_id": "string",
  • "serial_number": "string",
  • "notes": "string",
  • "current_status": "OWNER",
  • "current_status_date": "2019-10-02T15:00:00Z",
  • "model": "string",
  • "year": 2021,
  • "manufacturer": "string"
}

Update Equipment

Update Equipment

path Parameters
id
required
string
header Parameters
client-id
string
Request Body schema: application/json
id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

org_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

name
string
property_ids
Array of objects <uuid> (UUID Canonical textual representation)
object (BasicExtendedAttribute)
label
string
Enum: "EARTH_MOVING" "FORAGE_AND_HAY" "HARVESTING" "PLANTER" "SPRAYER" "TILLAGE" "TRACTOR" "TRAILER" "TRUCK" "GENERICAL_VEHICLE" "IRRIGATION" "MANURE" "MISC" "FERTILIZER" "SHOP"
licensing_number
string
unit_id
string
serial_number
string
notes
string
current_status
string
Enum: "OWNER" "CONTRACTED" "LEASED" "SOLD" "JUNKED" "CONTRACT_TERMINATED" "LEASE_TERMINATED"
current_status_date
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
model
string
year
integer
manufacturer
string
type
string
Enum: "IMPLEMENT" "VEHICLE"

Responses

Request samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "string",
  • "property_ids": [
    ],
  • "json_extended_attributes": {
    },
  • "label": "EARTH_MOVING",
  • "licensing_number": "string",
  • "unit_id": "string",
  • "serial_number": "string",
  • "notes": "string",
  • "current_status": "OWNER",
  • "current_status_date": "2019-10-02",
  • "model": "string",
  • "year": 0,
  • "manufacturer": "string",
  • "type": "IMPLEMENT"
}

Response samples

Content type
application/json
{
  • "name": "Name",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "type": "VEHICLE",
  • "id": "002f4753-5c5b-5dbd-8ed6-f0a83f86090d",
  • "json_extended_attributes": {
    },
  • "property_ids": [
    ],
  • "label": "TRUCK",
  • "licensing_number": "string",
  • "unit_id": "string",
  • "serial_number": "string",
  • "notes": "string",
  • "current_status": "OWNER",
  • "current_status_date": "2019-10-02T15:00:00Z",
  • "model": "string",
  • "year": 2021,
  • "manufacturer": "string"
}

delete-equipment-by-id

Delete the specified Equipment.

path Parameters
id
required
string

Responses

Get Equipments by Ids

Get Equipments by its Ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted organizations

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

type
string
Enum: "VEHICLE" "IMPLEMENT"

Equipment can be filtered by type. The type query can be VEHICLE or IMPLEMENT or empty (return both types)

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Equipment Creator

Creates equipments for organizations

header Parameters
client-id
string
Request Body schema: application/json
org_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

name
string
property_ids
Array of objects <uuid> (UUID Canonical textual representation)
object (BasicExtendedAttribute)
label
string
Enum: "EARTH_MOVING" "FORAGE_AND_HAY" "HARVESTING" "PLANTER" "SPRAYER" "TILLAGE" "TRACTOR" "TRAILER" "TRUCK" "GENERICAL_VEHICLE" "IRRIGATION" "MANURE" "MISC" "FERTILIZER" "SHOP"
licensing_number
string
unit_id
string
serial_number
string
notes
string
current_status
string
Enum: "OWNER" "CONTRACTED" "LEASED" "SOLD" "JUNKED" "CONTRACT_TERMINATED" "LEASE_TERMINATED"
current_status_date
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
model
string
year
integer
manufacturer
string
type
string
Enum: "IMPLEMENT" "VEHICLE"

Responses

Request samples

Content type
application/json
{
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "string",
  • "property_ids": [
    ],
  • "json_extended_attributes": {
    },
  • "label": "EARTH_MOVING",
  • "licensing_number": "string",
  • "unit_id": "string",
  • "serial_number": "string",
  • "notes": "string",
  • "current_status": "OWNER",
  • "current_status_date": "2019-10-02",
  • "model": "string",
  • "year": 0,
  • "manufacturer": "string",
  • "type": "IMPLEMENT"
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "property_ids": [
    ],
  • "type": "VEHICLE",
  • "name": "Equip Name",
  • "label": "TRUCK",
  • "json_extended_attributes": {
    },
  • "licensing_number": "string",
  • "unit_id": "string",
  • "serial_number": "string",
  • "notes": "string",
  • "current_status": "OWNER",
  • "current_status_date": "2019-10-02T15:00:00Z",
  • "model": "string",
  • "year": 2021,
  • "manufacturer": "string"
}

List Organization equipments with filtered extra_attribute

List Organization Equipments with ExtendedAttribute

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

name
string

Equipments will be filtered by names containing the string in Equipment name

type
string

Equipment can be filtered by type. The type query can be VEHICLE or IMPLEMENT

extra_attribute
string

Filtered by multiple key-value pair "name":"some-name","type":"some-type"

include_extended
required
boolean

Filtered extra-Attribute only if include_extended = true

header Parameters
Accept-Language
string

Names will be responded in the chosen language

client-id
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "last": true,
  • "total_elements": 3,
  • "size": 2147483647,
  • "number": 0,
  • "number_of_elements": 3,
  • "sort": {
    },
  • "first": true,
  • "empty": false
}

List Organization equipments

List Organization Equipments

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

name
string

Equipments will be filtered by names containing the string in Equipment name

type
string

Equipment can be filtered by type. The type query can be VEHICLE or IMPLEMENT

header Parameters
Accept-Language
string

Names will be responded in the chosen language

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Errors

Multiple error definitions

Field

Field listing, editing and creation

Get Cycle's season-fields

Get Cycle's Season-fields

path Parameters
cycleId
required
string

Cycle ID.

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Current Season by Field Id

Get Current Season by Field Id

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
include_extended
boolean
header Parameters
client-id
string

Responses

Response samples

Content type
application/json
{
  • "name": "Watermelon season 2020",
  • "start_date": "2020-04-01T09:06:26.000+0000",
  • "end_date": "2020-07-31T09:06:26.000+0000",
  • "crop_id": "6d5203f7-2b5c-485e-a6f8-b080ef1cf1a9",
  • "org_id": "384f0b5f-25a5-4102-85ca-7c4fa43a7832",
  • "active": true,
  • "deleted": false,
  • "json_extended_attributes": {
    },
  • "id": "d06e2de7-6b50-4dda-853e-ab7952def05f"
}

Delete Field history by id

Delete a field's version. The request is executed asynchronously, so at the end of the request the process may not be completed.

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

UUID from field

version_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

UUID from field versioning

Responses

Field history details by id

Get the history of field by id

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

UUID from area

query Parameters
include_deleted
boolean

True to fetch deleted area

since
string <date-time> (String with a date format)
Example: since=2019-10-02

Date in format ISO "yyyy-MM-dd", Start date of area history

https://tools.ietf.org/html/rfc3339#section-5.6
until
string <date-time> (String with a date format)
Example: until=2019-10-02

Date in format ISO "yyyy-MM-dd", End date of area history

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Response samples

Content type
application/json
{
  • "current": {
    },
  • "history": [
    ]
}

Get Seasons by Field Id

Get Seasons by Field Id

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "size": 2147483647,
  • "number": 0,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "empty": false
}

Field details by version

Get the specified field by version

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
attributes
Array of strings
Items Value: "geometry"

Enable geometry in response

reference_date
string <date-time>
Example: reference_date=2021-01-30T08:30:00Z

The reference date as ISO ("yyyy-mm-dd")

Responses

Response samples

Content type
application/json
{
  • "name": "Field Example",
  • "property_id": "aab63ec2-4756-11ea-8d24-5e6d0beb7caa",
  • "parent_region_id": "acfce85d-14ce-42d5-9685-cf260192550f",
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "declared_area": 8.1,
  • "event_date": "2019-10-02T00:00:00.000Z",
  • "id": "ba69208b-d8fa-4603-be43-aef2ebda9003"
}

Restore field by version

Get the specified field by version

path Parameters
id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
attributes
Array of strings
Items Value: "geometry"

Enable geometry in response

reference_date
string <date-time>
Example: reference_date=2021-01-30T08:30:00Z

The reference date as ISO ("yyyy-mm-dd")

restore
boolean

Restore or return the field by version

Responses

Response samples

Content type
application/json
{
  • "name": "Field Example",
  • "property_id": "aab63ec2-4756-11ea-8d24-5e6d0beb7caa",
  • "parent_region_id": "acfce85d-14ce-42d5-9685-cf260192550f",
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "declared_area": 8.1,
  • "event_date": "2019-10-02T00:00:00.000Z",
  • "id": "ba69208b-d8fa-4603-be43-aef2ebda9003"
}

Field details

Get the specified Field details.

path Parameters
id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
attributes
Array of strings
Items Value: "geometry"

Enable geometry in response

reference_date
string <date-time> (String with a date format)
Example: reference_date=2019-10-02

Filter on reference_date

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Response samples

Content type
application/json
{
  • "name": "Field Example",
  • "property_id": "aab63ec2-4756-11ea-8d24-5e6d0beb7caa",
  • "parent_region_id": "acfce85d-14ce-42d5-9685-cf260192550f",
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "declared_area": 8.1,
  • "event_date": "2019-10-02T00:00:00.000Z",
  • "id": "ba69208b-d8fa-4603-be43-aef2ebda9003"
}

Edit existing Field

Edits an existing Field with the specified id. The event_date param will define if the field will be edit or will create a new version. The request is executed asynchronously, so at the end of the request the process may not be completed.

path Parameters
id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

header Parameters
client-id
string
Request Body schema: application/json

Details of the field to be updated.

id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

name
required
string
parent_region_id
required
object <uuid>

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

property_id
required
object <uuid>

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

declared_area
required
number

Area is always represented in Hectares

calculated_area
number
tags
Array of strings
object (Point)

GeoJSON geometry

http://geojson.org/geojson-spec.html#id2
object (BasicExtendedAttribute)
event_date
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Request samples

Content type
application/json
{
  • "name": "Field Example",
  • "property_id": "aab63ec2-4756-11ea-8d24-5e6d0beb7caa",
  • "parent_region_id": "acfce85d-14ce-42d5-9685-cf260192550f",
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "declared_area": 8.1,
  • "event_date": "2019-10-02T00:00:00.000Z",
  • "id": "ba69208b-d8fa-4603-be43-aef2ebda9003"
}

Response samples

Content type
application/json
{
  • "name": "Field Example",
  • "property_id": "aab63ec2-4756-11ea-8d24-5e6d0beb7caa",
  • "parent_region_id": "acfce85d-14ce-42d5-9685-cf260192550f",
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "declared_area": 8.1,
  • "event_date": "2019-10-02T00:00:00.000Z",
  • "id": "ba69208b-d8fa-4603-be43-aef2ebda9003"
}

Delete Field By ID

Delete the specified Field. The request is executed asynchronously, so at the end of the request the process may not be completed.

path Parameters
id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Get Fields by Ids

Get Fields by its Ids. If an id does not exist, it does not return it.

query Parameters
reference_date
string <date-time> (String with a date format)
Example: reference_date=2019-10-02

Filter on reference_date

https://tools.ietf.org/html/rfc3339#section-5.6
attributes
Array of strings
Items Value: "geometry"

Enable geometry in response

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

List fields

List the fields of a given Region.

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

parent_region_id
required
object <uuid> (UUID Canonical textual representation)
Example: parent_region_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

attributes
Array of strings
Items Value: "geometry"

Enable geometry in response

tags
Array of strings

Tags to filter

reference_date
string <date-time> (String with a date format)
Example: reference_date=2019-10-02

Filter on reference_date

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Create Field

Create a Field. The request is executed asynchronously, so at the end of the request the process may not be completed.

header Parameters
client-id
string
Request Body schema: application/json

Details of the field to be created.

name
required
string
parent_region_id
required
object <uuid>

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

property_id
required
object <uuid>

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

declared_area
required
number

Area is always represented in Hectares

calculated_area
number
tags
Array of strings
object (Point)

GeoJSON geometry

http://geojson.org/geojson-spec.html#id2
object (BasicExtendedAttribute)
event_date
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Request samples

Content type
application/json
{
  • "name": "Field Example",
  • "property_id": "aab63ec2-4756-11ea-8d24-5e6d0beb7caa",
  • "parent_region_id": "acfce85d-14ce-42d5-9685-cf260192550f",
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "declared_area": 8.1,
  • "event_date": "2019-10-02T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "name": "Field Example",
  • "property_id": "aab63ec2-4756-11ea-8d24-5e6d0beb7caa",
  • "parent_region_id": "acfce85d-14ce-42d5-9685-cf260192550f",
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "declared_area": 8.1,
  • "event_date": "2019-10-02T00:00:00.000Z",
  • "id": "ba69208b-d8fa-4603-be43-aef2ebda9003"
}

List of property's season fields

Get the current season fields from a specifief property

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

lastUpdateDate
string <date-time> (String with a date format)
Example: lastUpdateDate=2019-10-02

The last updated date. It will find occurrences after or equals this date

https://tools.ietf.org/html/rfc3339#section-5.6
deleted
required
boolean

Indicates which operation should be applied. If true find only deleted registers else created/updated

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "totalElements": 4,
  • "totalPages": 1,
  • "last": true,
  • "sort": {
    },
  • "numberOfElements": 4,
  • "first": true,
  • "size": 2147483647,
  • "number": 0,
  • "empty": false
}

Performs field geometry updates

A fields batch that can be created, updated or deleted. The request is executed asynchronously, so at the end of the request the process may not be completed.

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: 42

id of the Property.

query Parameters
attributes
Array of strings
Items Value: "saved_fields"

Optional parameter that informs that the saved fields must be returned

Request Body schema: application/json
version
string (Object version)
Value: "v1"

Version of the request object

strict
boolean (Strict mode)

If enabled, the request either succeeds completely or fails completely. If disabled, regions which can be changed will be changed, and the others will return an error, indicated individually by region in the response.

relative_root
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

format
required
string
Value: "geojson"

Currently supports only GeoJSON in with the property schema listed below.

required
object (Region Collection)

GeoJSON Feature collection

https://tools.ietf.org/html/rfc7946#section-3.3

Responses

Request samples

Content type
application/json
{
  • "version": "v1",
  • "strict": true,
  • "relative_root": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "format": "geojson",
  • "region_set": {
    }
}

Response samples

Content type
application/json
Example
Fully accepted
Fully accepted
Partially accepted
Fully accepted with saved fields
{
  • "status": "FULLY_ACCEPTED",
  • "errors": [ ]
}

Query results and version identifiers of previous updates.

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: 42

id of the Property.

query Parameters
since
string <date-time> (String with a date format)
Example: since=2019-10-02

Start date of the desired time window (inclusive).

https://tools.ietf.org/html/rfc3339#section-5.6
until
string <date-time> (String with a date format)
Example: until=2019-10-02

End date of the desired time window (exclusive).

https://tools.ietf.org/html/rfc3339#section-5.6
reference_date
string <date-time> (String with a date format)
Example: reference_date=2019-10-02

Filter on reference_date

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Response samples

Content type
application/json
{
  • "type": "FeatureCollection",
  • "features": [
    ]
}

Query results and version identifiers of previous updates.

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: 42

id of the Property.

query Parameters
since
string <date-time> (String with a date format)
Example: since=2019-10-02

Start date of the desired time window (inclusive).

https://tools.ietf.org/html/rfc3339#section-5.6
until
string <date-time> (String with a date format)
Example: until=2019-10-02

End date of the desired time window (exclusive).

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Response samples

Content type
application/json
{
  • "type": "FeatureCollection",
  • "features": [
    ]
}

List Fields of the Season

List the Season/Field relationship of the specified Season. It can be filtered using a query parameter to specify a Property.

path Parameters
season_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

property_id
string

An UUID Property id

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Perform a batch of operations related to Season and `land` (Properties and Fields)

Associate/dissociate properties and/or fields to/from a Season.

path Parameters
season_id
required
string
Request Body schema: application/json
required
Array of objects (A season-land operation)

Responses

Request samples

Content type
application/json
{
  • "updates": [
    ]
}

List Seasons Fields of Seasons and Properties

List the Season/Field relationship for specifieds Seasons. It can be filtered by passing a property id. If none is passed, no season field is filtered.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted organizations

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
any (Season and Properties Ids List)

Responses

Request samples

Content type
application/json
{
  • "properties_by_season": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Perform batch of operations related to each Season and `land` (Properties and Fields)

Associate/dissociate properties and/or fields to/from each Season.

Request Body schema: application/json
required
Array of objects (A season-land batch operation)

Responses

Request samples

Content type
application/json
{
  • "batch": [
    ]
}

Field Geometry Updates

Creates and retrieves results of map update operations.

Performs field geometry updates

A fields batch that can be created, updated or deleted. The request is executed asynchronously, so at the end of the request the process may not be completed.

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: 42

id of the Property.

query Parameters
attributes
Array of strings
Items Value: "saved_fields"

Optional parameter that informs that the saved fields must be returned

Request Body schema: application/json
version
string (Object version)
Value: "v1"

Version of the request object

strict
boolean (Strict mode)

If enabled, the request either succeeds completely or fails completely. If disabled, regions which can be changed will be changed, and the others will return an error, indicated individually by region in the response.

relative_root
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

format
required
string
Value: "geojson"

Currently supports only GeoJSON in with the property schema listed below.

required
object (Region Collection)

GeoJSON Feature collection

https://tools.ietf.org/html/rfc7946#section-3.3

Responses

Request samples

Content type
application/json
{
  • "version": "v1",
  • "strict": true,
  • "relative_root": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "format": "geojson",
  • "region_set": {
    }
}

Response samples

Content type
application/json
Example
Fully accepted
Fully accepted
Partially accepted
Fully accepted with saved fields
{
  • "status": "FULLY_ACCEPTED",
  • "errors": [ ]
}

GeoJSON

GeoJSON models and definitions

Legal Documents

Legal Documents listing, editing and creation

Licensing

Licensing status and info

Licensing Status

The licensing status returned is grouped by app. Often, the "apps" list will just include one object, which is the calling app. In specific cases (like inter-app integrations), other apps may be configured to share their licensing information with other applications. In this case, you will see this information too if you request it (see "apps" parameter). Querystring parameters:

  • org: ID of the Organization to be checked. Mutually exclusive with account.
  • account: ID of the workspace (not the User). Mutually exclusive with org. Either org or account must be present.
  • apps:
    • description: Which apps should have their licensing info included in the response.
    • acceptable values:
      • me (default): just the calling app
      • all: the calling app, plus all the apps that have agreed to share licensing information with the calling app (if any). This sharing MAY be partial (for example, entitlements are shared but quotas are not).
  • fields:
    • description: a comma-separated list of strings specifying fields to include
    • default value: entitlements
    • acceptable values:
      • all: add all available fields
      • entitlements: add entitlements
      • quotas: add quotas and their usages
      • meta: add all metadata (Accounts and Contracts). Clients can set up to 1KB of metadata for each Contract or Account to make it easier to store free-form external info for human consumption or system integrations.
      • meta(account): add only Account metadata
      • meta(contract): add only Contract metadata
      • notes: add contract notes to the response
query Parameters
org
string

Id of the organization

account
string

Id of the workspace

apps
string
Enum: "me" "all"

Which apps should have their licensing info included in the response.

fields
any

Which apps should have their licensing info included in the response

include_deleted_contracts
string

Sets if the response will return the deleted contracts or not

Responses

Response samples

Content type
application/json
{
  • "account": {
    },
  • "apps": [
    ],
  • "org": {
    }
}

Organization

Organization listing, editing and creation

List Organization equipments with filtered extra_attribute

List Organization Equipments with ExtendedAttribute

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

name
string

Equipments will be filtered by names containing the string in Equipment name

type
string

Equipment can be filtered by type. The type query can be VEHICLE or IMPLEMENT

extra_attribute
string

Filtered by multiple key-value pair "name":"some-name","type":"some-type"

include_extended
required
boolean

Filtered extra-Attribute only if include_extended = true

header Parameters
Accept-Language
string

Names will be responded in the chosen language

client-id
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "last": true,
  • "total_elements": 3,
  • "size": 2147483647,
  • "number": 0,
  • "number_of_elements": 3,
  • "sort": {
    },
  • "first": true,
  • "empty": false
}

List Organization seasons with filtered extra_attribute

Gets all seasons of an Organization with ExtendedAttribute

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

include_extended
boolean
extra_attribute
string

Filtered by multiple key-value pair "name":"some-name","type":"some-type"

header Parameters
client-id
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Org Accounts

path Parameters
org_id
required
string
query Parameters
exclude_attributes
string

List of attributes to be excluded, must be separated by comma

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "$ref": "#/components/examples/PagedAccount"
}

Installed apps for Org

Get All Apps

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

parent_region_id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: parent_region_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

attributes
Array of strings
Items Value: "geometry"

Enable geometry in response

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

List Organization's Cycles

Gets all cycles of an Organization

path Parameters
orgId
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

List Organization equipments

List Organization Equipments

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

name
string

Equipments will be filtered by names containing the string in Equipment name

type
string

Equipment can be filtered by type. The type query can be VEHICLE or IMPLEMENT

header Parameters
Accept-Language
string

Names will be responded in the chosen language

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

List Invitation Statuses for an Organization

Gets all invites status of an Organization.

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

status_list
string

A comma seperated list of status to be returned in response.

Responses

Response samples

Content type
application/json
{
  • "$ref": "#/components/examples/PagedInviteStatus"
}

Get Organization Photo

Requests the Organization main photo.

path Parameters
org_id
required
string

Responses

Upload Organization Photo

Uploads Organization main photo.

path Parameters
org_id
required
string
Request Body schema: multipart/form-data

Multipart Form including the picture file

file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "avatar_url": "https://base-strix-assets-dev.s3.amazonaws.com/org/a36eb6ab-0fb5-41fe-9a37-36c463e224bc "
}

Remove Organization Photo

Removes the Organization main photo.

path Parameters
org_id
required
string

Responses

List Organization properties

Gets all properties of an Organization and optionally the total area of each property.

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

include_inactive
boolean

Requested deleted properties. Default is false.

name
string

Filter properties by name. Default is null

attributes
Array of strings
Items Value: "total_area"

Optional area sum for property

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

List Organization seasons

Gets all seasons of an Organization

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

include_extended
boolean
header Parameters
client-id
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

List Organization Products

List Organization Products

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

filters
string

A boolean filter kind of logical expression to filter data

show_canonicals
boolean

Shows the canonical products in the response

location
string

Filter by location

header Parameters
Accept-Language
string

Names will be responded in the chosen language

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Get Task By Organization

Get the tasks of a specified organization

path Parameters
org_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json

List of Task for an Organization

property_ids
Array of objects <uuid> (UUID Canonical textual representation)
season_ids
Array of objects <uuid> (UUID Canonical textual representation)
field_ids
Array of objects <uuid> (UUID Canonical textual representation)
region_ids
Array of objects <uuid> (UUID Canonical textual representation)
season_field_ids
Array of objects <uuid> (UUID Canonical textual representation)
status_ids
Array of objects <uuid> (UUID Canonical textual representation)
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "property_ids": [
    ],
  • "fields_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Get task by organization

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

season_id
object <uuid> (UUID Canonical textual representation)
Example: season_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

Tasks will be filtered by season_id

since
string <date-time> (String with a date format)
Example: since=2019-10-02

Tasks will be filtered by start date

https://tools.ietf.org/html/rfc3339#section-5.6
until
string <date-time> (String with a date format)
Example: until=2019-10-02

Tasks will be filtered by end date

https://tools.ietf.org/html/rfc3339#section-5.6
property_id
object <uuid> (UUID Canonical textual representation)
Example: property_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

deleted
boolean

Tasks will be filtered by deletion status

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

List Organization Workers

List Organization Workers

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

name
string

Workers will be filtered by names containing the string in Worker name

header Parameters
Accept-Language
string

Names will be responded in the chosen language

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Organization Details

Gets the specified Organization details.

path Parameters
org_id
required
string
query Parameters
attributes
Array of strings
Items Value: "total_area"

Optional area sum for property

Responses

Response samples

Content type
application/json
{}

Organization Updater

Edits an existing Organization with the specified id.

path Parameters
org_id
required
string
header Parameters
client-id
string
Request Body schema: application/json

Details of the Organization to be updated.

id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

name
required
string
address
string
city
string
state
string
country
required
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "IS" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

ISO-3166 Reference to Country Codes 3166-1 alpha-2

https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
zip_code
string
place_id
string
phone
string (Phone Number)

E.164 international phone number formatting

https://www.itu.int/rec/T-REC-E.164/en
email
string <email>
employer_identification_number
string
currency
required
string
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"
unit_system
required
string
Enum: "METRIC" "IMPERIAL"
deleted
boolean
object (Point)

GeoJSON geometry

http://geojson.org/geojson-spec.html#id2
picture_url
string <uri>
object (BasicExtendedAttribute)
licensing_account_id
object <uuid> (UUID Canonical textual representation) Recursive

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

workspace_id
required
object <uuid> (UUID Canonical textual representation) Recursive

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Request samples

Content type
application/json
{
  • "id": "34550190-7d4f-4a03-91ec-4f5568e50029",
  • "name": "Test user's Company",
  • "address": "Inconfidentes St, 911",
  • "city": "Belo Horizonte",
  • "state": "Minas Gerais",
  • "country": "BR",
  • "zip_code": "33000-999",
  • "place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
  • "currency": "USD",
  • "unit_system": "METRIC",
  • "phone": "+5531911112222",
  • "json_extended_attributes": {
    }
}

Response samples

Content type
application/json
{
  • "name": "Dummy's Organization",
  • "address": null,
  • "city": null,
  • "state": null,
  • "country": "IN",
  • "zip_code": null,
  • "place_id": null,
  • "currency": "USD",
  • "unit_system": "METRIC",
  • "phone": "+91 97686-6211",
  • "email": "dummy@dum.com",
  • "employer_identification_number": null,
  • "json_extended_attributes": {
    },
  • "picture_url": "https://base-strix-assets-dev.s3.amazonaws.com/org/a36eb6ab-0fb5-41fe-9a37-36c463e224bc",
  • "deleted": false,
  • "id": "a36eb6ab-0fb5-41fe-9a37-36c463e224bc"
}

delete-org-by-id

Delete the specified Organization.

path Parameters
org_id
required
string

Responses

Get Orgs' Accounts by Orgs' Ids

Get Accounts by its org's Ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted accounts

exclude_attributes
string

List of attributes to be excluded

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Orgs' Invites by Orgs' Ids and its status

Get Invites by its org's Ids. If an id does not exist, it does not return it.

query Parameters
status_list
string

A comma seperated list of status to be returned in response.

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "$ref": "#/components/examples/PagedInviteStatus"
}

List Organization Workers by Property Id and Name

List Worker in a Organization by properties ids. If an empty list is sent, it return all workers from that organization

path Parameters
org_id
required
string
query Parameters
name
string

Filter worker by its name

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Get Orgs' Properties by Orgs' Ids

Get Properties by its org's Ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted properties

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Orgs' Seasons by Orgs' Ids

Get Seasons by its org's Ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted seasons

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Orgs by Ids

Get Orgs by its Ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted organizations

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

List allowed Organizations

Gets all Organizations that are allowed to the authenticated Account.

query Parameters
licensing_accounts
Array of strings

Filter results by workspaces.

workspaces
Array of strings

Filter results by workspaces.

attributes
string
Enum: "workspaces" "licensing_accounts"

Show organizations with their workspaces

name
string

Filter results by name.

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

attributes
Array of strings
Items Value: "total_area"

Optional area sum for property

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Organization Creator

Create an Organization

header Parameters
client-id
string
Request Body schema: application/json

Details of the Organization to be created

name
required
string
address
string
city
string
state
string
country
required
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "IS" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

ISO-3166 Reference to Country Codes 3166-1 alpha-2

https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
zip_code
string
place_id
string
phone
string (Phone Number)

E.164 international phone number formatting

https://www.itu.int/rec/T-REC-E.164/en
email
string <email>
employer_identification_number
string
currency
required
string
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"
unit_system
required
string
Enum: "METRIC" "IMPERIAL"
deleted
boolean
object (Point)

GeoJSON geometry

http://geojson.org/geojson-spec.html#id2
picture_url
string <uri>
object (BasicExtendedAttribute)
licensing_account_id
object <uuid> (UUID Canonical textual representation) Recursive

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

workspace_id
required
object <uuid> (UUID Canonical textual representation) Recursive

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Request samples

Content type
application/json
{
  • "name": "Test user's Company",
  • "address": "Inconfidentes St, 911",
  • "city": "Belo Horizonte",
  • "state": "Minas Gerais",
  • "country": "BR",
  • "zip_code": "33000-999",
  • "place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
  • "currency": "USD",
  • "unit_system": "METRIC",
  • "phone": "+5531911112222",
  • "json_extended_attributes": {
    }
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "AD",
  • "zip_code": "string",
  • "place_id": "string",
  • "phone": "+5531900000000",
  • "email": "user@example.com",
  • "employer_identification_number": "string",
  • "currency": "AED",
  • "unit_system": "METRIC",
  • "deleted": true,
  • "reference_point": {
    },
  • "picture_url": "http://example.com",
  • "json_extended_attributes": {
    },
  • "licensing_account_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "workspace_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Get worker

Get Worker

path Parameters
id
required
string
orgId
required
string

Responses

Response samples

Content type
application/json
{
  • "org_id": "06a34cd3-9e09-7b8d-8a7d-112ac07776a3",
  • "name": "Worker Name",
  • "id": "06a36cd3-9e09-4b8d-8a7d-112ac07776a3",
  • "property_ids": [
    ],
  • "note": "string",
  • "address": "string",
  • "type": "EMPLOYEE",
  • "applicator_licensing_number": "string",
  • "license_valid_through": "2020-04-01T09:06:26.000+0000"
}

Update worker

Update Worker

path Parameters
id
required
string
orgId
required
string
header Parameters
client-id
string
Request Body schema: application/json
id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

name
required
string
property_ids
Array of objects <uuid> (UUID Canonical textual representation)
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

object (BasicExtendedAttribute)
note
string
address
string
type
string
Enum: "EMPLOYEE" "EXTERNAL_COMPANY"
email
string
phone
string
applicator_licensing_number
string
license_valid_through
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Request samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "string",
  • "property_ids": [
    ],
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "json_extended_attributes": {
    },
  • "note": "string",
  • "address": "string",
  • "type": "EMPLOYEE",
  • "email": "string",
  • "phone": "string",
  • "applicator_licensing_number": "string",
  • "license_valid_through": "2019-10-02"
}

Response samples

Content type
application/json
{
  • "org_id": "06a34cd3-9e09-7b8d-8a7d-112ac07776a3",
  • "name": "Update Worker Name",
  • "id": "06a36cd3-9e09-4b8d-8a7d-112ac07776a3",
  • "json_extended_attributes": {
    },
  • "property_ids": [
    ],
  • "note": "string",
  • "address": "string",
  • "type": "EMPLOYEE",
  • "applicator_licensing_number": "string",
  • "license_valid_through": "2020-04-01T09:06:26.000+0000"
}

delete-worker-by-id

Delete the specified Worker.

path Parameters
id
required
string
orgId
required
string

Responses

Create worker

Create Worker

path Parameters
orgId
required
string
header Parameters
client-id
string
Request Body schema: application/json
id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

name
required
string
property_ids
Array of objects <uuid> (UUID Canonical textual representation)
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

object (BasicExtendedAttribute)
note
string
address
string
type
string
Enum: "EMPLOYEE" "EXTERNAL_COMPANY"
email
string
phone
string
applicator_licensing_number
string
license_valid_through
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Request samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "string",
  • "property_ids": [
    ],
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "json_extended_attributes": {
    },
  • "note": "string",
  • "address": "string",
  • "type": "EMPLOYEE",
  • "email": "string",
  • "phone": "string",
  • "applicator_licensing_number": "string",
  • "license_valid_through": "2019-10-02"
}

Response samples

Content type
application/json
{
  • "org_id": "06a34cd3-9e09-7b8d-8a7d-112ac07776a3",
  • "name": "Worker Name",
  • "id": "06a36cd3-9e09-4b8d-8a7d-112ac07776a3",
  • "json_extended_attributes": {
    },
  • "property_ids": [
    ],
  • "note": "string",
  • "address": "string",
  • "type": "EMPLOYEE",
  • "applicator_licensing_number": "string",
  • "license_valid_through": "2020-04-01T09:06:26.000+0000"
}

Get Root owners from the orgs that the workspace id is linked

Get Root owners from the orgs that the workspace id is linked. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted accounts

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Policy

Policy listing, editing and creation

Get policies by Context

Get policies from context

path Parameters
context
required
string

The context the policy belongs to

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "number_of_elements": 1,
  • "last": true,
  • "first": true,
  • "empty": false
}

Get policy by Context and Id

Get policy data

path Parameters
context
required
string

The context the policy belongs to

policyId
required
string

The policy id

Responses

Response samples

Content type
application/json
{
  • "id": "DevEdit",
  • "name": "Dev Edit",
  • "context": "system",
  • "version": 1,
  • "level": "app",
  • "permissions": [
    ]
}

Plans

Plans listing, editing and creation

Get Contracts By Plan

Get all contracts from a plan

path Parameters
planId
required
string
query Parameters
size
integer

Number of contracts to return

last_key
string

Id of the last contract returned by the previous query

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Plans By App

Get all plans from a single app

path Parameters
appId
required
string

Numeric ID of the app to get

query Parameters
size
integer

Number of plans to return

last_key
string

Id of the last plan returned by the previous query

name
string

Filter plans containing this name

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Accounts of Plan

path Parameters
planId
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get Campaigns of plans

Get all campaigns from a plan

path Parameters
planId
required
string

Numeric ID of the plan to get

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Delete Plan

Removes a single plan

path Parameters
planId
required
string

Numeric ID of the plan to remove

Responses

Response samples

Content type
application/json
{
  • "status": "plan deleted successfully"
}

Get Plan by Id

Get a single plan

path Parameters
planId
required
string

Numeric ID of the plan to get

query Parameters
include_deleted
boolean

Boolean to flag the inclusion of deleted plans

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "app": "string",
  • "default": true,
  • "default_duration": 0,
  • "deleted": true,
  • "entitlements": [
    ],
  • "name": "string",
  • "quotas": [
    ],
  • "terms": [
    ],
  • "valid_countries": [
    ],
  • "accounts": [
    ],
  • "location": "string",
  • "legalDocuments": [
    ]
}

Edit Plan

Updates a single plan

path Parameters
planId
required
string

Numeric ID of the plan to update

Request Body schema: application/json
created_at
string <date-time>
id
string
metadata
object
updated_at
string <date-time>
app
required
string
default
boolean
default_duration
integer
deleted
boolean
Array of objects (EntitlementsList)
name
required
string
Array of objects
terms
Array of strings
valid_countries
Array of strings
accounts
Array of strings
location
string
legalDocuments
Array of strings

Responses

Request samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "app": "string",
  • "default": true,
  • "default_duration": 0,
  • "deleted": true,
  • "entitlements": [
    ],
  • "name": "string",
  • "quotas": [
    ],
  • "terms": [
    ],
  • "valid_countries": [
    ],
  • "accounts": [
    ],
  • "location": "string",
  • "legalDocuments": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "app": "string",
  • "default": true,
  • "default_duration": 0,
  • "deleted": true,
  • "entitlements": [
    ],
  • "name": "string",
  • "quotas": [
    ],
  • "terms": [
    ],
  • "valid_countries": [
    ],
  • "accounts": [
    ],
  • "location": "string",
  • "legalDocuments": [
    ]
}

Get All Plans

Get all plans

query Parameters
size
integer

Number of plans to return

last_key
string

Id of the last plan returned by the previous query

name
string

Filter plans containing this name

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Create a new Plan

Creates a new plan

Request Body schema: application/json
created_at
string <date-time>
id
string
metadata
object
updated_at
string <date-time>
app
required
string
default
boolean
default_duration
integer
deleted
boolean
Array of objects (EntitlementsList)
name
required
string
Array of objects
terms
Array of strings
valid_countries
Array of strings
accounts
Array of strings
location
string
legalDocuments
Array of strings

Responses

Request samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "app": "string",
  • "default": true,
  • "default_duration": 0,
  • "deleted": true,
  • "entitlements": [
    ],
  • "name": "string",
  • "quotas": [
    ],
  • "terms": [
    ],
  • "valid_countries": [
    ],
  • "accounts": [
    ],
  • "location": "string",
  • "legalDocuments": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "app": "string",
  • "default": true,
  • "default_duration": 0,
  • "deleted": true,
  • "entitlements": [
    ],
  • "name": "string",
  • "quotas": [
    ],
  • "terms": [
    ],
  • "valid_countries": [
    ],
  • "accounts": [
    ],
  • "location": "string",
  • "legalDocuments": [
    ]
}

Product

Product listing, editing and creation

List Organization Products

List Organization Products

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

filters
string

A boolean filter kind of logical expression to filter data

show_canonicals
boolean

Shows the canonical products in the response

location
string

Filter by location

header Parameters
Accept-Language
string

Names will be responded in the chosen language

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Get a Product

List Product

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "org_id": "06a34cd3-9e09-7b8d-8a7d-112ac07776a3",
  • "name": "Product Name",
  • "id": "06a36cd3-9e09-4b8d-8a7d-112ac07776a3",
  • "manufacturer": "Manufacturer Name",
  • "unit_of_measurement": "KILOGRAMS",
  • "type": "VARIETY"
}

Update product

Update Product

path Parameters
id
required
string
Request Body schema: application/json
name
required
string
unit_of_measurement
string
Enum: "KILOGRAMS" "LITERS" "UNITS" "BOXS" "SACK" "GALLONS" "GRAMS" "TONNES" "MILLILITER" "METERS" "OUNCES" "POUNDS" "PINTS" "DOSE"
type
string
Enum: "VARIETY" "FUEL" "PART" "FERTILIZER" "GENERIC_PRODUCT" "PESTICIDE" "ADJUVANT" "LUBRICANT" "INOCULANT" "ACARICIDE" "MICROBIOLOGICAL_ACARICIDE" "BIOLOGICAL_CONTROL_AGENT" "PLANT_ACTIVATOR" "BACTERICIDE" "MICROBIOLOGICAL_BACTERICIDE" "TERMITICIDE" "PHEROMONE" "FORMICIDE" "FUNGICIDE" "MICROBIOLOGICAL_FUNGICIDE" "HERBICIDE" "INSECTICIDE" "FUMIGANT_INSECTICIDE" "MICROBIOLOGICAL_INSECTICIDE" "MOLLUSCICIDE" "NEMATICIDE" "MICROBIOLOGICAL_NEMATICIDE" "SEED_PROTECTOR" "GROWTH_REGULATOR" "STIMULATING"
org_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

manufacturer
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "unit_of_measurement": "KILOGRAMS",
  • "type": "VARIETY",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "manufacturer": "string"
}

Response samples

Content type
application/json
{
  • "org_id": "06a34cd3-9e09-7b8d-8a7d-112ac07776a3",
  • "name": "Update Product Name",
  • "id": "06a36cd3-9e09-4b8d-8a7d-112ac07776a3",
  • "manufacturer": "Manufacturer Name",
  • "unit_of_measurement": "KILOGRAMS",
  • "type": "VARIETY"
}

delete-product-by-id

Delete the specified Product.

path Parameters
id
required
string

Responses

List products

List Products

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

header Parameters
Accept-Language
string

Products names will be responded in the chosen language

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Create Product

Create Product

Request Body schema: application/json
name
required
string
unit_of_measurement
string
Enum: "KILOGRAMS" "LITERS" "UNITS" "BOXS" "SACK" "GALLONS" "GRAMS" "TONNES" "MILLILITER" "METERS" "OUNCES" "POUNDS" "PINTS" "DOSE"
type
string
Enum: "VARIETY" "FUEL" "PART" "FERTILIZER" "GENERIC_PRODUCT" "PESTICIDE" "ADJUVANT" "LUBRICANT" "INOCULANT" "ACARICIDE" "MICROBIOLOGICAL_ACARICIDE" "BIOLOGICAL_CONTROL_AGENT" "PLANT_ACTIVATOR" "BACTERICIDE" "MICROBIOLOGICAL_BACTERICIDE" "TERMITICIDE" "PHEROMONE" "FORMICIDE" "FUNGICIDE" "MICROBIOLOGICAL_FUNGICIDE" "HERBICIDE" "INSECTICIDE" "FUMIGANT_INSECTICIDE" "MICROBIOLOGICAL_INSECTICIDE" "MOLLUSCICIDE" "NEMATICIDE" "MICROBIOLOGICAL_NEMATICIDE" "SEED_PROTECTOR" "GROWTH_REGULATOR" "STIMULATING"
org_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

manufacturer
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "unit_of_measurement": "KILOGRAMS",
  • "type": "VARIETY",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "manufacturer": "string"
}

Response samples

Content type
application/json
{
  • "org_id": "06a34cd3-9e09-7b8d-8a7d-112ac07776a3",
  • "name": "Product Name",
  • "id": "06a36cd3-9e09-4b8d-8a7d-112ac07776a3",
  • "manufacturer": "Manufacturer Name",
  • "unit_of_measurement": "KILOGRAMS",
  • "type": "VARIETY"
}

Property

Property listing, editing and creation

List Organization properties

Gets all properties of an Organization and optionally the total area of each property.

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

include_inactive
boolean

Requested deleted properties. Default is false.

name
string

Filter properties by name. Default is null

attributes
Array of strings
Items Value: "total_area"

Optional area sum for property

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

List Organization Workers by Property Id and Name

List Worker in a Organization by properties ids. If an empty list is sent, it return all workers from that organization

path Parameters
org_id
required
string
query Parameters
name
string

Filter worker by its name

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Get Orgs' Properties by Orgs' Ids

Get Properties by its org's Ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted properties

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

List of property's season fields

Get the current season fields from a specifief property

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

lastUpdateDate
string <date-time> (String with a date format)
Example: lastUpdateDate=2019-10-02

The last updated date. It will find occurrences after or equals this date

https://tools.ietf.org/html/rfc3339#section-5.6
deleted
required
boolean

Indicates which operation should be applied. If true find only deleted registers else created/updated

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "totalElements": 4,
  • "totalPages": 1,
  • "last": true,
  • "sort": {
    },
  • "numberOfElements": 4,
  • "first": true,
  • "size": 2147483647,
  • "number": 0,
  • "empty": false
}

List Property's Cycles

Gets all cycles of an Property

path Parameters
propertyId
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

List property fields history

Get the Fields history of an specified property and optionally the Geometry of each Field

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
attributes
Array of strings
Items Value: "geometry"

Enable fields in

contract_id
object <uuid> (UUID Canonical textual representation) Recursive
Example: contract_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "fields": [
    ]
}

List property fields

Get the Fields of an specified property and optionally the Geometry of each Field

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

attributes
Array of strings
Items Value: "geometry"

Enable fields in

reference_date
string

Filter on reference_date

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

List properties regionTree

Get the regionTree of an specified property

path Parameters
propertyId
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
reference_date
string

Filter on reference_date

Responses

Response samples

Content type
application/json
{
  • "calculated_area": null,
  • "children_region": [
    ],
  • "created_at": "2021-03-24T23:42:33.000Z",
  • "declared_area": null,
  • "deleted_at": null,
  • "fields": [ ],
  • "id": "b327eff3-629a-436c-bdf3-232239aaf33e",
  • "last_modified": "2021-04-29T02:23:59.000Z",
  • "name": "ajays region",
  • "parent_id": null,
  • "property_id": "593b6155-d5b1-4876-9885-3bc3ea0409de"
}

List regions history

Get the Region history of an specified property

path Parameters
propertyId
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "regions": [
    ]
}

List regions

Get the Region of an specified property

path Parameters
propertyId
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
reference_date
string

Filter on reference_date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List season areas updates since last update

Get the season areas updates since last update by property

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
last_update_date
required
string <date-time> (String with a date format)
Example: last_update_date=2019-10-02

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
deleted
required
boolean
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "pageable": {
    }
}

List property seasons

Get the seasons of a specified property

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "pageable": {
    }
}

List property tasks

Get the tasks of a specified property

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

season_id
object <uuid> (UUID Canonical textual representation)
Example: season_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

Tasks will be filtered by season_id

since
string <date-time> (String with a date format)
Example: since=2019-10-02

Tasks will be filtered by dates (start and end date)

https://tools.ietf.org/html/rfc3339#section-5.6
until
string <date-time> (String with a date format)
Example: until=2019-10-02

Tasks will be filtered by dates (start and end date)

https://tools.ietf.org/html/rfc3339#section-5.6
attributes
Array of strings
Items Value: "geometry"

Enable fields in response

tags
Array of strings

Tasks will be filtered by tags when containing one or more of those strings

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Property Details

Gets the property details and optionally total area. Possible query parameters:

  • total_area: get total area of this property's Fields.
path Parameters
property_id
required
string
query Parameters
attributes
Array of strings
Items Value: "total_area"

Responses

Response samples

Content type
application/json
Example
Property has been found
Property has been found
Property has been found using attributes=total_area
{
  • "org_id": "384f0b5f-25a5-4102-85ca-7c4fa43a7832",
  • "root_region_id": "ad23de56-0312-4a6c-b576-27a16ee8cc2d",
  • "name": "User's Farm",
  • "time_zone": "Asia/Kolkata",
  • "country": null,
  • "state": null,
  • "city": null,
  • "address": null,
  • "zip_code": null,
  • "place_id": null,
  • "reference_point": {
    },
  • "deleted": false,
  • "id": "dc2b45a4-3554-4c81-ab55-635d231c2810"
}

Edit existing Property

Edits an existing Property with the specified id.

path Parameters
property_id
required
string
header Parameters
client-id
string
Request Body schema: application/json

Details of the Property to be updated.

name
required
string
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

root_region_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

time_zone
required
string (TimeZone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Asmera" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/ComodRivadavia" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Catamarca" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Coral_Harbour" "America/Cordoba" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fort_Wayne" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Jujuy" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Knox_IN" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Louisville" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Rosario" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Ashkhabad" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Calcutta" "Asia/Chita" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Chungking" "Asia/Colombo" "Asia/Dacca" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Katmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macao" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Saigon" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimbu" "Asia/Thimphu" "Asia/Tokyo" "Asia/Ujung_Pandang" "Asia/Ulaanbaatar" "Asia/Ulan_Bator" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faeroe" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/ACT" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/LHI" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/North" "Australia/NSW" "Australia/Perth" "Australia/Queensland" "Australia/South" "Australia/Sydney" "Australia/Tasmania" "Australia/Victoria" "Australia/West" "Australia/Yancowinna" "Canada/Atlantic" "Canada/Central" "Canada/East-Saskatchewan" "Canada/Eastern" "Canada/Mountain" "Canada/Newfoundland" "Canada/Pacific" "Canada/Saskatchewan" "Canada/Yukon" "Chile/Continental" "Chile/EasterIsland" "Cuba" "Egypt" "Eire" "Europe/Amsterdam" "Europe/Andorra" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Greenwich" "Hongkong" "Iceland" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Iran" "Israel" "Jamaica" "Japan" "Kwajalein" "Libya" "Mexico/BajaNorte" "Mexico/BajaSur" "Mexico/General" "Navajo" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Ponape" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Truk" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "Poland" "Portugal" "Singapore" "Universal" "US/Alaska" "US/Aleutian" "US/Arizona" "US/Central" "US/East-Indiana" "US/Eastern" "US/Hawaii" "US/Indiana-Starke" "US/Michigan" "US/Mountain" "US/Pacific" "US/Pacific-New" "US/Samoa"
country
string
state
string
city
string
address
string
zip_code
string
place_id
string
fields_updated_at
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
required
object (Point)

GeoJSON geometry

http://geojson.org/geojson-spec.html#id2
object (A two letter country code)
object (BasicExtendedAttribute)

Responses

Request samples

Content type
application/json
{
  • "org_id": "6d5ccc3b-bf9a-4678-a6fb-0b9f7b9eb425",
  • "name": "Sample edited Farm",
  • "time_zone": "America/Sao_Paulo",
  • "country": "Brazil",
  • "state": "MG",
  • "city": "BH",
  • "address": "rua",
  • "zip_code": "33333-111",
  • "place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
  • "json_extended_attributes": {
    },
  • "reference_point": {
    },
  • "id": "915f59f9-e351-4ab7-974a-41c347826cfa"
}

Response samples

Content type
application/json
{
  • "org_id": "85010338-88c4-49ca-a480-79b7146c2058",
  • "root_region_id": "31f8433c-ff3e-47fd-9ffd-000da1d4c2b4",
  • "name": "User's Farm",
  • "time_zone": "Asia/Kolkata",
  • "country": "India",
  • "state": "Maharashtra",
  • "city": "Pune",
  • "address": "Pune",
  • "zip_code": "411014",
  • "place_id": null,
  • "json_extended_attributes": {
    },
  • "reference_point": {
    },
  • "deleted": false,
  • "id": "3aa8e4e9-9638-49f9-81f9-95f652bd89d3"
}

Delete Property By ID

Delete the specified property.

path Parameters
property_id
required
string

Responses

Get Properties By Ids

Get Properties by its org's Ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted properties

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Create property

Creates a property.

header Parameters
client-id
string
Request Body schema: application/json

Details of the Property to be created.

name
required
string
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

root_region_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

time_zone
required
string (TimeZone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Asmera" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/ComodRivadavia" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Catamarca" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Coral_Harbour" "America/Cordoba" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fort_Wayne" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Jujuy" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Knox_IN" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Louisville" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Rosario" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Ashkhabad" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Calcutta" "Asia/Chita" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Chungking" "Asia/Colombo" "Asia/Dacca" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Katmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macao" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Saigon" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimbu" "Asia/Thimphu" "Asia/Tokyo" "Asia/Ujung_Pandang" "Asia/Ulaanbaatar" "Asia/Ulan_Bator" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faeroe" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/ACT" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/LHI" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/North" "Australia/NSW" "Australia/Perth" "Australia/Queensland" "Australia/South" "Australia/Sydney" "Australia/Tasmania" "Australia/Victoria" "Australia/West" "Australia/Yancowinna" "Canada/Atlantic" "Canada/Central" "Canada/East-Saskatchewan" "Canada/Eastern" "Canada/Mountain" "Canada/Newfoundland" "Canada/Pacific" "Canada/Saskatchewan" "Canada/Yukon" "Chile/Continental" "Chile/EasterIsland" "Cuba" "Egypt" "Eire" "Europe/Amsterdam" "Europe/Andorra" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Greenwich" "Hongkong" "Iceland" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Iran" "Israel" "Jamaica" "Japan" "Kwajalein" "Libya" "Mexico/BajaNorte" "Mexico/BajaSur" "Mexico/General" "Navajo" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Ponape" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Truk" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "Poland" "Portugal" "Singapore" "Universal" "US/Alaska" "US/Aleutian" "US/Arizona" "US/Central" "US/East-Indiana" "US/Eastern" "US/Hawaii" "US/Indiana-Starke" "US/Michigan" "US/Mountain" "US/Pacific" "US/Pacific-New" "US/Samoa"
country
string
state
string
city
string
address
string
zip_code
string
place_id
string
fields_updated_at
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
required
object (Point)

GeoJSON geometry

http://geojson.org/geojson-spec.html#id2
object (A two letter country code)
object (BasicExtendedAttribute)

Responses

Request samples

Content type
application/json
{
  • "org_id": "6d5ccc3b-bf9a-4678-a6fb-0b9f7b9eb425",
  • "name": "Sample Farm",
  • "time_zone": "America/Sao_Paulo",
  • "country": "Brazil",
  • "state": "MG",
  • "city": "BH",
  • "address": "rua",
  • "zip_code": "33333-111",
  • "place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
  • "json_extended_attributes": {
    },
  • "reference_point": {
    }
}

Response samples

Content type
application/json
{
  • "org_id": "85010338-88c4-49ca-a480-79b7146c2058",
  • "root_region_id": "cd492bb0-161c-4c98-923c-2f746cb8e5ce",
  • "name": "New Property",
  • "time_zone": "Asia/Kolkata",
  • "country": "India",
  • "state": "MH",
  • "city": "Amravati",
  • "address": "New Address",
  • "zip_code": "444606",
  • "place_id": null,
  • "json_extended_attributes": {
    },
  • "reference_point": {
    },
  • "deleted": false,
  • "id": "76b74b0d-3143-45c9-9fa2-f9a9843b8b02"
}

Perform a batch of operations related to Season and `land` (Properties and Fields)

Associate/dissociate properties and/or fields to/from a Season.

path Parameters
season_id
required
string
Request Body schema: application/json
required
Array of objects (A season-land operation)

Responses

Request samples

Content type
application/json
{
  • "updates": [
    ]
}

List Properties of the Season

List the Season/Property relationship of the specified Season and optionally the Season/Field relationship for each Season/Property.

path Parameters
season_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

List Seasons Fields of Seasons and Properties

List the Season/Field relationship for specifieds Seasons. It can be filtered by passing a property id. If none is passed, no season field is filtered.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted organizations

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
any (Season and Properties Ids List)

Responses

Request samples

Content type
application/json
{
  • "properties_by_season": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Perform batch of operations related to each Season and `land` (Properties and Fields)

Associate/dissociate properties and/or fields to/from each Season.

Request Body schema: application/json
required
Array of objects (A season-land batch operation)

Responses

Request samples

Content type
application/json
{
  • "batch": [
    ]
}

Region

Region listing, editing and creation

Region history details by id

Get the history of region by id

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

UUID from region

query Parameters
include_deleted
boolean

True to fetch deleted area

since
string <date-time> (String with a date format)
Example: since=2019-10-02

Date in format ISO "yyyy-MM-ddTHH:mm:ssZ", Start date of area history

https://tools.ietf.org/html/rfc3339#section-5.6
until
string <date-time> (String with a date format)
Example: until=2019-10-02

Date in format ISO "yyyy-MM-ddTHH:mm:ssZ", End date of area history

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Response samples

Content type
application/json
{
  • "current": {
    },
  • "history": [
    ]
}

Region

Create a Region. The request is executed asynchronously, so at the end of the request the process may not be completed.

header Parameters
client-id
string
Request Body schema: application/json
name
required
string
parent_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

property_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

calculated_area
number
declared_area
required
number
object (Point)

GeoJSON geometry

http://geojson.org/geojson-spec.html#id2
object (BasicExtendedAttribute)
event_date
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Request samples

Content type
application/json
{
  • "name": "region35",
  • "property_id": "2e5e26a4-95d8-4198-83eb-3bcfc62f95e3",
  • "parent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "calculated_area": 2.5,
  • "declared_area": "30",
  • "event_date": "2019-10-02T15:00:00.000Z",
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "reference_point": {
    }
}

Response samples

Content type
application/json
{
  • "id": "b152e9b1-f858-4f89-83ca-be18054c8048",
  • "name": "region35",
  • "parent_id": "20b014b1-e81e-4a4f-991e-e8db908aee42",
  • "property_id": "2e5e26a4-95d8-4198-83eb-3bcfc62f95e3",
  • "declared_area": 30,
  • "calculated_area": 2.5,
  • "event_date": "2019-10-02T15:00:00.000Z",
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "reference_point": {
    }
}

List fields by regions

Get the fields of an specified region

path Parameters
regionId
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
reference_date
string <date-time> (String with a date format)
Example: reference_date=2019-10-02

Filter on reference_date

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Region history by id

Delete a region's version. The request is executed asynchronously, so at the end of the request the process may not be completed.

path Parameters
id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

UUID from region

version_id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

UUID from region versioning

Responses

List regions by parent

Get the parentRegion of an specified region

path Parameters
regionId
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
reference_date
string <date-time> (String with a date format)
Example: reference_date=2019-10-02

Filter on reference_date

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Response samples

Content type
application/json
{
  • "id": "b152e9b1-f858-4f89-83ca-be18054c8048",
  • "name": "region35 new",
  • "parent_id": "20b014b1-e81e-4a4f-991e-e8db908aee42",
  • "property_id": "2e5e26a4-95d8-4198-83eb-3bcfc62f95e3",
  • "declared_area": 40,
  • "calculated_area": 2.5,
  • "geometry": {
    },
  • "reference_point": {
    }
}

List regionTree

Get the regionTree of an specified region

path Parameters
regionId
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
reference_date
string <date-time> (String with a date format)
Example: reference_date=2019-10-02

Filter on reference_date

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Response samples

Content type
application/json
{
  • "calculated_area": null,
  • "children_region": [
    ],
  • "created_at": "2021-03-24T23:42:33.000Z",
  • "declared_area": null,
  • "deleted_at": null,
  • "fields": [ ],
  • "id": "b327eff3-629a-436c-bdf3-232239aaf33e",
  • "last_modified": "2021-04-29T02:23:59.000Z",
  • "name": "ajays region",
  • "parent_id": null,
  • "property_id": "593b6155-d5b1-4876-9885-3bc3ea0409de"
}

List regions

Get the Region of an specified region

path Parameters
regionId
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
reference_date
string <date-time> (String with a date format)
Example: reference_date=2019-10-02

Filter on reference_date

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Region details

Get the specified Region details.

path Parameters
id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "id": "b152e9b1-f858-4f89-83ca-be18054c8048",
  • "name": "region35",
  • "parent_id": "20b014b1-e81e-4a4f-991e-e8db908aee42",
  • "property_id": "2e5e26a4-95d8-4198-83eb-3bcfc62f95e3",
  • "declared_area": 30,
  • "calculated_area": 2.5,
  • "geometry": {
    },
  • "reference_point": {
    }
}

Edit existing Region

Edits an existing Region with the specified id. The event_date param will define if the region will be edit or will create a new version. The request is executed asynchronously, so at the end of the request the process may not be completed.

path Parameters
id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

header Parameters
client-id
string
Request Body schema: application/json

Details of the Region to be updated.

type
required
string
Value: "Feature"
id
required
object <uuid>

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

required
object (Region Properties)

Identified structure that represents all the feature characteristics and its parenthood relationship.

If the operation is create, but an update condition is set, either in this region or in the parent, this region will be rejected (and the whole request may be rejected if strict mode is turned on in the update request).

If the operation is update, the event_date param will define if the field will be edit or will create a new version.

event_date
string <date-time>

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
name
required
string
parent_id
required
object <uuid> (UUID Canonical textual representation) Recursive

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

property_id
required
object <uuid> (UUID Canonical textual representation) Recursive

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

calculated_area
number
declared_area
required
number
object (Point)

GeoJSON geometry

http://geojson.org/geojson-spec.html#id2
object (BasicExtendedAttribute)

Responses

Request samples

Content type
application/json
Example
Region to edit
Region to edit
Root region to edit
{
  • "name": "region35 new",
  • "parent_id": "20b014b1-e81e-4a4f-991e-e8db908aee42",
  • "property_id": "2e5e26a4-95d8-4198-83eb-3bcfc62f95e3",
  • "declared_area": 40,
  • "event_date": "2019-10-02T00:00:00.000Z",
  • "calculated_area": 2.5,
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "reference_point": {
    }
}

Response samples

Content type
application/json
{
  • "id": "b152e9b1-f858-4f89-83ca-be18054c8048",
  • "name": "region35 new",
  • "parent_id": "20b014b1-e81e-4a4f-991e-e8db908aee42",
  • "property_id": "2e5e26a4-95d8-4198-83eb-3bcfc62f95e3",
  • "declared_area": 40,
  • "calculated_area": 2.5,
  • "event_date": "2019-10-02T00:00:00.000Z",
  • "json_extended_attributes": {
    },
  • "geometry": {
    },
  • "reference_point": {
    }
}

Delete Region By ID

Delete the specified Region. The request is executed asynchronously, so at the end of the request the process may not be completed.

path Parameters
id
required
object <uuid> (UUID Canonical textual representation) Recursive
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Get all regions by its ids

Get the Regions by its ids

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted regions

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

reference_date
string <date-time> (String with a date format)
Example: reference_date=2019-10-02

Filter on reference_date

https://tools.ietf.org/html/rfc3339#section-5.6
Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Performs region geometry updates

A regions batch that can be created, updated or deleted. The request is executed asynchronously, so at the end of the request the process may not be completed.

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: 42

id of the Property.

Request Body schema: application/json
version
string (Object version)
Value: "v1"

Version of the request object

strict
boolean (Strict mode)

If enabled, the request either succeeds completely or fails completely. If disabled, regions which can be changed will be changed, and the others will return an error, indicated individually by region in the response.

relative_root
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

format
required
string
Value: "geojson"

Currently supports only GeoJSON in with the property schema listed below.

required
object (Region Collection)

GeoJSON Feature collection

https://tools.ietf.org/html/rfc7946#section-3.3

Responses

Request samples

Content type
application/json
{
  • "version": "v1",
  • "strict": true,
  • "relative_root": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "format": "geojson",
  • "region_set": {
    }
}

Response samples

Content type
application/json
Example
Fully accepted
Fully accepted
Partially accepted
{
  • "status": "FULLY_ACCEPTED",
  • "errors": [ ]
}

Role

Role listing, editing and creation

Get Account's Roles

Return the roles of an account

path Parameters
account_id
required
string

Account ID.

query Parameters
last_key
string
size
integer

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "number_of_elements": 1,
  • "last": true,
  • "first": true,
  • "empty": false
}

Batch get account roles by ids

Return the roles of accounts

query Parameters
last_key
string
size
integer
Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "number_of_elements": 1,
  • "last": true,
  • "first": true,
  • "empty": false
}

Season

Season listing, editing and creation

Get Cycle's season

Get Cycle's Seasons

path Parameters
cycleId
required
string

Cycle ID.

query Parameters
include_deleted
boolean

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Attach/Deattach Cycle's season

Attach/Deattach Cycle's season

path Parameters
cycleId
required
string

Cycle ID.

Request Body schema: application/json
required
Array of objects (OperationAttachSeasonDTO)

Responses

Request samples

Content type
application/json
{
  • "updates": [
    ]
}

Response samples

Content type
application/json
{
  • "accepted_seasons": [
    ],
  • "refused_seasons": [
    ]
}

Get Current Season by Field Id

Get Current Season by Field Id

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
include_extended
boolean
header Parameters
client-id
string

Responses

Response samples

Content type
application/json
{
  • "name": "Watermelon season 2020",
  • "start_date": "2020-04-01T09:06:26.000+0000",
  • "end_date": "2020-07-31T09:06:26.000+0000",
  • "crop_id": "6d5203f7-2b5c-485e-a6f8-b080ef1cf1a9",
  • "org_id": "384f0b5f-25a5-4102-85ca-7c4fa43a7832",
  • "active": true,
  • "deleted": false,
  • "json_extended_attributes": {
    },
  • "id": "d06e2de7-6b50-4dda-853e-ab7952def05f"
}

Get Seasons by Field Id

Get Seasons by Field Id

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "size": 2147483647,
  • "number": 0,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "empty": false
}

List Organization seasons with filtered extra_attribute

Gets all seasons of an Organization with ExtendedAttribute

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

include_extended
boolean
extra_attribute
string

Filtered by multiple key-value pair "name":"some-name","type":"some-type"

header Parameters
client-id
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

List Organization seasons

Gets all seasons of an Organization

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

include_extended
boolean
header Parameters
client-id
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Orgs' Seasons by Orgs' Ids

Get Seasons by its org's Ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted seasons

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

List property seasons

Get the seasons of a specified property

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "pageable": {
    }
}

List Fields of the Season

List the Season/Field relationship of the specified Season. It can be filtered using a query parameter to specify a Property.

path Parameters
season_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

property_id
string

An UUID Property id

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Perform a batch of operations related to Season and `land` (Properties and Fields)

Associate/dissociate properties and/or fields to/from a Season.

path Parameters
season_id
required
string
Request Body schema: application/json
required
Array of objects (A season-land operation)

Responses

Request samples

Content type
application/json
{
  • "updates": [
    ]
}

List Properties of the Season

List the Season/Property relationship of the specified Season and optionally the Season/Field relationship for each Season/Property.

path Parameters
season_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Season Details

Gets the specified Season details.

path Parameters
season_id
required
string
query Parameters
include_extended
boolean
header Parameters
client-id
string

Responses

Response samples

Content type
application/json
{
  • "name": "Watermelon season 2020",
  • "start_date": "2020-04-01T09:06:26.000+0000",
  • "end_date": "2020-07-31T09:06:26.000+0000",
  • "crop_id": "6d5203f7-2b5c-485e-a6f8-b080ef1cf1a9",
  • "org_id": "384f0b5f-25a5-4102-85ca-7c4fa43a7832",
  • "active": true,
  • "deleted": false,
  • "json_extended_attributes": {
    },
  • "id": "d06e2de7-6b50-4dda-853e-ab7952def05f"
}

Season Updater

Update the specified Season.

path Parameters
season_id
required
string
header Parameters
client-id
string
Request Body schema: application/json

Details of the Season to be updated.

id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

active
boolean
deleted
boolean
name
required
string
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

start_date
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
end_date
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
crop_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Request samples

Content type
application/json
{
  • "name": "Apple season 2020",
  • "start_date": "2020-06-01T12:13:37.000+0000",
  • "end_date": "2020-07-28T12:13:37.000+0000",
  • "crop_id": "09616ba5-c12d-4028-a1f6-5f10ca2a4ff0",
  • "org_id": "85010338-88c4-49ca-a480-79b7146c2058",
  • "active": true,
  • "deleted": false,
  • "json_extended_attributes": {
    },
  • "id": "bbb41ba0-a337-4949-9959-ed371d04ebbc"
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "active": true,
  • "deleted": true,
  • "name": "string",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "start_date": "2019-10-02",
  • "end_date": "2019-10-02",
  • "crop_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

delete-season-by-id

Delete the specified Season.

path Parameters
season_id
required
string

Responses

List Seasons Fields of Seasons and Properties

List the Season/Field relationship for specifieds Seasons. It can be filtered by passing a property id. If none is passed, no season field is filtered.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted organizations

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
any (Season and Properties Ids List)

Responses

Request samples

Content type
application/json
{
  • "properties_by_season": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Seasons by Ids

Get Seasons by its Ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted seasons

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 2,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 2,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Perform batch of operations related to each Season and `land` (Properties and Fields)

Associate/dissociate properties and/or fields to/from each Season.

Request Body schema: application/json
required
Array of objects (A season-land batch operation)

Responses

Request samples

Content type
application/json
{
  • "batch": [
    ]
}

Season Creator

Create a season.

header Parameters
client-id
string
Request Body schema: application/json

Details of the Season to be created

name
required
string
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

start_date
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
end_date
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
crop_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

object (Season Relationship)

Responses

Request samples

Content type
application/json
Example
Create Season
Create Season
Create Season with relationships
{
  • "name": "Season Test - 2020/21",
  • "org_id": "34550190-7d4f-4a03-91ec-4f5568e50029",
  • "start_date": "2020-01-31T20:47:15.767Z",
  • "end_date": "2021-01-31T20:47:15.767Z",
  • "crop_id": "010b7b54-e006-4afc-a843-436b909ce90d"
}

Response samples

Content type
application/json
{
  • "name": "Watermelon season 2020",
  • "start_date": "2020-04-01T09:06:26.418+0000",
  • "end_date": "2020-07-31T09:06:26.418+0000",
  • "crop_id": "6d5203f7-2b5c-485e-a6f8-b080ef1cf1a9",
  • "org_id": "384f0b5f-25a5-4102-85ca-7c4fa43a7832",
  • "active": true,
  • "deleted": false,
  • "json_extended_attributes": {
    },
  • "id": "d06e2de7-6b50-4dda-853e-ab7952def05f"
}

Store

Store listing

Get App By Id in Store

Get App By Id in Store

path Parameters
app_id
required
string
query Parameters
workspace_id
required
string
include_expired_contracts
boolean

Search for App in Store with expired contract

Responses

Response samples

Content type
application/json
{
  • "id": "f0d59ad7-b2c2-490a-965c-2899fc09c44b",
  • "name": "Basic App Name",
  • "short_description": "Short description goes here",
  • "detailed_description": "Detailed description goes here",
  • "published": true,
  • "site_uri": "http://site-uri.com",
  • "icon_uri": "http://icon-uri.com",
  • "image_uri": "http://image-uri.com"
}

List Apps in Store per workspace

List Apps in Store per workspace, for all the workspaces with at least one organization.

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

filter_by_language
boolean

Filter apps by accept-language header. Default true

include_default_workspace
boolean

Includes the default workspace on the response, even if it doesn't have an org. Default false

include_unpublished
boolean

Returns unpublished apps as well as published ones. Default false

Responses

Response samples

Content type
application/json
{}

List Apps in Store

List Apps in Store

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

workspace_id
object <uuid> (UUID Canonical textual representation)
Example: workspace_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

licensing_account_id
object <uuid> (UUID Canonical textual representation)
Example: licensing_account_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

filter_by_language
string

Filter apps by accept-language header. Default true

include_default_workspace
string

include default workspace. Default false

include_unpublished
string

Include unpublished apps. Default false

include_clients_info
string

Include clients info. Default false

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Task

Tasks listing

Get Task By Organization

Get the tasks of a specified organization

path Parameters
org_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json

List of Task for an Organization

property_ids
Array of objects <uuid> (UUID Canonical textual representation)
season_ids
Array of objects <uuid> (UUID Canonical textual representation)
field_ids
Array of objects <uuid> (UUID Canonical textual representation)
region_ids
Array of objects <uuid> (UUID Canonical textual representation)
season_field_ids
Array of objects <uuid> (UUID Canonical textual representation)
status_ids
Array of objects <uuid> (UUID Canonical textual representation)
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "property_ids": [
    ],
  • "fields_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Get task by organization

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

season_id
object <uuid> (UUID Canonical textual representation)
Example: season_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

Tasks will be filtered by season_id

since
string <date-time> (String with a date format)
Example: since=2019-10-02

Tasks will be filtered by start date

https://tools.ietf.org/html/rfc3339#section-5.6
until
string <date-time> (String with a date format)
Example: until=2019-10-02

Tasks will be filtered by end date

https://tools.ietf.org/html/rfc3339#section-5.6
property_id
object <uuid> (UUID Canonical textual representation)
Example: property_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

deleted
boolean

Tasks will be filtered by deletion status

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

List property tasks

Get the tasks of a specified property

path Parameters
property_id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

season_id
object <uuid> (UUID Canonical textual representation)
Example: season_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

Tasks will be filtered by season_id

since
string <date-time> (String with a date format)
Example: since=2019-10-02

Tasks will be filtered by dates (start and end date)

https://tools.ietf.org/html/rfc3339#section-5.6
until
string <date-time> (String with a date format)
Example: until=2019-10-02

Tasks will be filtered by dates (start and end date)

https://tools.ietf.org/html/rfc3339#section-5.6
attributes
Array of strings
Items Value: "geometry"

Enable fields in response

tags
Array of strings

Tasks will be filtered by tags when containing one or more of those strings

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 1,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 1,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Get Task Status

Retrieve Task Status

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number": 0,
  • "number_of_elements": 0,
  • "size": 0,
  • "total_elements": 0,
  • "total_pages": 0,
  • "sort": {
    },
  • "pageable": {
    }
}

Get Task Categories

Retrieve Task Categories

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number": 0,
  • "number_of_elements": 0,
  • "size": 0,
  • "total_elements": 0,
  • "total_pages": 0,
  • "sort": {
    },
  • "pageable": {
    }
}

Comment Update

Update task by task-id

path Parameters
comment_id
required
string
Request Body schema: application/json
comment
string

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "comment": "string",
  • "created_at": "2019-10-02",
  • "account_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Delete Comment by Id

Delete the specified Task Comment.

path Parameters
comment_id
required
string

Responses

Post comment into Task

Create Task comment by Task Id

path Parameters
task_id
required
string
Request Body schema: application/json
comment
string

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "comment": "string",
  • "created_at": "2019-10-02",
  • "account_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Post Progress into Task

Create Task Progress by Task Id

path Parameters
task_id
required
string
Request Body schema: application/json
start_date
required
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
end_date
required
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
progress_amount
required
number

Responses

Request samples

Content type
application/json
{
  • "start_date": "2019-10-02",
  • "end_date": "2019-10-02",
  • "progress_amount": 0
}

Response samples

Content type
application/json
{
  • "start_date": "2019-10-02",
  • "end_date": "2019-10-02",
  • "progress_amount": 0
}

Task Details

Get Task by Id

path Parameters
task_id
required
string

Responses

Response samples

Content type
application/json
{
  • "description": "Coverage",
  • "org_id": "ba670bec-33f1-4689-b3a9-4e4ff7a01558",
  • "property_id": "9ec7cd46-5cf7-4137-98d2-6d2d9e90ea11",
  • "season_id": "ee971900-c9dd-45c5-a8b9-b9cc377994bc",
  • "start_date": "2020-06-02T08:00:00.000+0000",
  • "end_date": "2020-06-06T18:00:00.000+0000",
  • "status_id": "c56e4d21-a01e-4d9d-8e5c-f2334de8ad21",
  • "category_resources": {
    },
  • "comments": [
    ]
}

Task Update

Update task by task-id

path Parameters
task_id
required
string
header Parameters
client-id
string
Request Body schema: application/json
id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

property_ids
Array of objects <uuid> (UUID Canonical textual representation)
season_ids
Array of objects <uuid> (UUID Canonical textual representation)
description
required
string
duration
integer

The duration must be in minutes

external_id
integer

The external_id is an incremental value by default, but the value can be provided by the client

start_date
required
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
end_date
required
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
status_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

required
object (SamplingCategoryResources)
object (BasicExtendedAttribute)
tags
Array of strings
Array of objects (Basic Task Comment)
Array of objects (ProgressLogDrilldown)

Only available for Get wont be available in Post call.

Responses

Request samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "property_ids": [
    ],
  • "season_ids": [
    ],
  • "description": "string",
  • "duration": 0,
  • "external_id": 0,
  • "start_date": "2019-10-02",
  • "end_date": "2019-10-02",
  • "status_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "category_resources": {
    },
  • "json_extended_attributes": {
    },
  • "tags": [
    ],
  • "comments": [
    ],
  • "progress_drilldown": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "Coverage",
  • "org_id": "ba670bec-33f1-4689-b3a9-4e4ff7a01558",
  • "property_id": "9ec7cd46-5cf7-4137-98d2-6d2d9e90ea11",
  • "season_id": "ee971900-c9dd-45c5-a8b9-b9cc377994bc",
  • "start_date": "2020-06-02T08:00:00.000+0000",
  • "end_date": "2020-06-06T18:00:00.000+0000",
  • "status_id": "c56e4d21-a01e-4d9d-8e5c-f2334de8ad21",
  • "json_extended_attributes": {
    },
  • "category_resources": {
    },
  • "comments": [
    ]
}

Delete task

Delete the specified Task.

path Parameters
task_id
required
string

Responses

Task Creator

Create Task

header Parameters
client-id
string
Request Body schema: application/json
id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

property_ids
Array of objects <uuid> (UUID Canonical textual representation)
season_ids
Array of objects <uuid> (UUID Canonical textual representation)
description
required
string
duration
integer

The duration must be in minutes

external_id
integer

The external_id is an incremental value by default, but the value can be provided by the client

start_date
required
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
end_date
required
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6
status_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

required
object (SamplingCategoryResources)
object (BasicExtendedAttribute)
tags
Array of strings
Array of objects (Basic Task Comment)
Array of objects (ProgressLogDrilldown)

Only available for Get wont be available in Post call.

Responses

Request samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "property_ids": [
    ],
  • "season_ids": [
    ],
  • "description": "string",
  • "duration": 0,
  • "external_id": 0,
  • "start_date": "2019-10-02",
  • "end_date": "2019-10-02",
  • "status_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "category_resources": {
    },
  • "json_extended_attributes": {
    },
  • "tags": [
    ],
  • "comments": [
    ],
  • "progress_drilldown": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "Coverage",
  • "org_id": "ba670bec-33f1-4689-b3a9-4e4ff7a01558",
  • "property_ids": [
    ],
  • "season_ids": [
    ],
  • "external_id": 1,
  • "duration": 2,
  • "start_date": "2020-06-02T08:00:00.000+0000",
  • "end_date": "2020-06-06T18:00:00.000+0000",
  • "status_id": "c56e4d21-a01e-4d9d-8e5c-f2334de8ad21",
  • "json_extended_attributes": {
    },
  • "category_resources": {
    },
  • "comments": [
    ]
}

Terms

Terms listing, editing and creation

Sign terms and Plans

Sign the term and plan

Request Body schema:
application/json
application/json
application/xml
Array ()
term_id
string
plan_id
string
accepted_on
string <date-time>

Responses

Request samples

Content type
application/json
application/json
application/xml
No sample

Response samples

Content type
application/json
[
  • {
    }
]

List All Terms

Get all terms

query Parameters
size
integer

Number of terms to return

last_key
string

Id of the last term returned by the previous query

name
string

Case insensitive term title or term title fragment

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Delete Terms

Removes a single term

path Parameters
termsId
required
string

Numeric ID of the term to remove

Responses

Response samples

Content type
application/json
{
  • "message": "term deleted successfully"
}

Get Terms By Id

Get a single term

path Parameters
termsId
required
string

Numeric ID of the term to get

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "content": "string",
  • "format": "plaintext",
  • "language": "string",
  • "title": "string"
}

Edit Terms

Updates a single term

path Parameters
termsId
required
string

Numeric ID of the term to update

Request Body schema: application/json
title
required
string
content
required
string
language
required
string
format
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "content": "string",
  • "language": "string",
  • "format": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "content": "string",
  • "format": "plaintext",
  • "language": "string",
  • "title": "string"
}

List User Terms

Get all terms from the current user

Responses

Response samples

Content type
application/json
No sample

Create a New Term

Creates a new term

Request Body schema: application/json
title
required
string
content
required
string
language
required
string
format
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "content": "string",
  • "language": "string",
  • "format": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "content": "string",
  • "format": "plaintext",
  • "language": "string",
  • "title": "string"
}

Token

Token and access management

Utils

General utility services

Convert KML or Shapefile to GeoJSON

Request Body schema: multipart/form-data

Multipart Form including either one single .kml file or a set of shapefiles (at least .shp, .shx and .dbf)

file
Array of strings <binary>

Responses

Request samples

Content type
multipart/form-data
No sample

Response samples

Content type
application/json
Example
FeatureCollection for KML file
FeatureCollection for KML file
FeatureCollection for shapefile
{
  • "type": "FeatureCollection",
  • "features": [
    ]
}

Get List of country codes in ISO3166Alpha2 format.

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

header Parameters
Accept-Language
string

regulatory zone list

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Variety

Variety listing

List varieties

List Varieties

query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

header Parameters
Accept-Language
string

Variety names will be responded in the chosen language

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Vouchers

Vouchers listing, editing and creation

Get Campaign Vouchers

Get all vouchers from a campaign

path Parameters
campaignId
required
string

Numeric ID of the campaign to get

query Parameters
size
integer

Number of vouchers to return

last_key
string

Id of the last voucher returned by the previous query

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Add Vouchers to Campaign

Add vouchers to a campaign

path Parameters
campaignId
required
string

Numeric ID of the campaign to toggle activation

Request Body schema: application/json
amount
required
number

Responses

Request samples

Content type
application/json
{
  • "amount": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Redeem Voucher

Redeem a voucher

Request Body schema: application/json
account
required
string
code
required
string

Responses

Request samples

Content type
application/json
{
  • "account": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "apps": [
    ]
}

Get All Plans from a Voucher

Get the redeem info that a voucher entitles

path Parameters
voucherId
required
string

Numeric ID of the voucher to get

query Parameters
include_app_basic_info
boolean

The endpoint will include the apps basic info if and only if this query parameter is true.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "consumed": true,
  • "active_campaign": true,
  • "campaign_duration": 0,
  • "plans": [
    ]
}

Delete Voucher by appId

Removes a single voucher

path Parameters
voucherId
required
string

Numeric ID of the voucher to remove

Responses

Response samples

Content type
application/json
{
  • "status": "voucher deleted successfully"
}

Get Voucher By Id

Get a single voucher

path Parameters
voucherId
required
string

Numeric ID of the voucher to get

Responses

Response samples

Content type
application/json
{
  • "campaign": "string",
  • "campaign_id": "string",
  • "code": "string",
  • "consumed": false,
  • "id": "string",
  • "link_id": "string"
}

Edit Voucher by ID

Updates a single voucher

path Parameters
voucherId
required
string

Numeric ID of the voucher to update

Request Body schema: application/json
consumed
boolean
consume_date
string

Responses

Request samples

Content type
application/json
{
  • "consumed": true,
  • "consume_date": "string"
}

Response samples

Content type
application/json
{
  • "campaign": "string",
  • "campaign_id": "string",
  • "code": "string",
  • "consumed": false,
  • "id": "string",
  • "link_id": "string"
}

Create Voucher

Creates a new voucher

Request Body schema: application/json
campaign
string
campaign_id
string
code
string
consumed
boolean
Default: false
id
string
link_id
string

Responses

Request samples

Content type
application/json
{
  • "campaign": "string",
  • "campaign_id": "string",
  • "code": "string",
  • "consumed": false,
  • "id": "string",
  • "link_id": "string"
}

Response samples

Content type
application/json
{
  • "campaign": "string",
  • "campaign_id": "string",
  • "code": "string",
  • "consumed": false,
  • "id": "string",
  • "link_id": "string"
}

Worker

Worker listing, editing and creation

List Organization Workers

List Organization Workers

path Parameters
org_id
required
string
query Parameters
page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

name
string

Workers will be filtered by names containing the string in Worker name

header Parameters
Accept-Language
string

Names will be responded in the chosen language

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

List Organization Workers by Property Id and Name

List Worker in a Organization by properties ids. If an empty list is sent, it return all workers from that organization

path Parameters
org_id
required
string
query Parameters
name
string

Filter worker by its name

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "last": true,
  • "total_elements": 2,
  • "total_pages": 1,
  • "size": 10,
  • "number": 0,
  • "number_of_elements": 2,
  • "first": true,
  • "sort": {
    },
  • "empty": false
}

Get worker

Get Worker

path Parameters
id
required
string
orgId
required
string

Responses

Response samples

Content type
application/json
{
  • "org_id": "06a34cd3-9e09-7b8d-8a7d-112ac07776a3",
  • "name": "Worker Name",
  • "id": "06a36cd3-9e09-4b8d-8a7d-112ac07776a3",
  • "property_ids": [
    ],
  • "note": "string",
  • "address": "string",
  • "type": "EMPLOYEE",
  • "applicator_licensing_number": "string",
  • "license_valid_through": "2020-04-01T09:06:26.000+0000"
}

Update worker

Update Worker

path Parameters
id
required
string
orgId
required
string
header Parameters
client-id
string
Request Body schema: application/json
id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

name
required
string
property_ids
Array of objects <uuid> (UUID Canonical textual representation)
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

object (BasicExtendedAttribute)
note
string
address
string
type
string
Enum: "EMPLOYEE" "EXTERNAL_COMPANY"
email
string
phone
string
applicator_licensing_number
string
license_valid_through
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Request samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "string",
  • "property_ids": [
    ],
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "json_extended_attributes": {
    },
  • "note": "string",
  • "address": "string",
  • "type": "EMPLOYEE",
  • "email": "string",
  • "phone": "string",
  • "applicator_licensing_number": "string",
  • "license_valid_through": "2019-10-02"
}

Response samples

Content type
application/json
{
  • "org_id": "06a34cd3-9e09-7b8d-8a7d-112ac07776a3",
  • "name": "Update Worker Name",
  • "id": "06a36cd3-9e09-4b8d-8a7d-112ac07776a3",
  • "json_extended_attributes": {
    },
  • "property_ids": [
    ],
  • "note": "string",
  • "address": "string",
  • "type": "EMPLOYEE",
  • "applicator_licensing_number": "string",
  • "license_valid_through": "2020-04-01T09:06:26.000+0000"
}

delete-worker-by-id

Delete the specified Worker.

path Parameters
id
required
string
orgId
required
string

Responses

Create worker

Create Worker

path Parameters
orgId
required
string
header Parameters
client-id
string
Request Body schema: application/json
id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

name
required
string
property_ids
Array of objects <uuid> (UUID Canonical textual representation)
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

object (BasicExtendedAttribute)
note
string
address
string
type
string
Enum: "EMPLOYEE" "EXTERNAL_COMPANY"
email
string
phone
string
applicator_licensing_number
string
license_valid_through
string <date-time> (String with a date format)

Full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

https://tools.ietf.org/html/rfc3339#section-5.6

Responses

Request samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "name": "string",
  • "property_ids": [
    ],
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "json_extended_attributes": {
    },
  • "note": "string",
  • "address": "string",
  • "type": "EMPLOYEE",
  • "email": "string",
  • "phone": "string",
  • "applicator_licensing_number": "string",
  • "license_valid_through": "2019-10-02"
}

Response samples

Content type
application/json
{
  • "org_id": "06a34cd3-9e09-7b8d-8a7d-112ac07776a3",
  • "name": "Worker Name",
  • "id": "06a36cd3-9e09-4b8d-8a7d-112ac07776a3",
  • "json_extended_attributes": {
    },
  • "property_ids": [
    ],
  • "note": "string",
  • "address": "string",
  • "type": "EMPLOYEE",
  • "applicator_licensing_number": "string",
  • "license_valid_through": "2020-04-01T09:06:26.000+0000"
}

Workspaces

Workspaces listing, editing and creation

Get WorkspaceIds from a App

Get all WorkspaceIds from a App

path Parameters
appId
required
string

Numeric ID of the App to get

query Parameters
include_inactive
boolean

Responses

Response samples

Content type
application/json
{
  • "workspace_ids": [
    ]
}

Get contracts by entitlements

query Parameters
entitlements
Array of strings
shouldContractHaveAllEntitlements
boolean
shouldConsiderDeletedContracts
boolean
lastKey
string
lastKeyComplement
integer

Responses

Response samples

Content type
application/json
{
  • "contracts": [
    ],
  • "lastKey": {
    }
}

Get Root owners from the orgs that the workspace id is linked

Get Root owners from the orgs that the workspace id is linked. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted accounts

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Delete entities in a workspace's contracts

Delete entities from all contracts from one workspace

path Parameters
workspaceId
required
string

Numeric ID of the account to get

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete workspace

Delete a single workspace

path Parameters
workspaceId
required
string

Numeric ID of the account to get

Responses

Response samples

Content type
application/json
{
  • "status": 100,
  • "code": "string",
  • "error": "string",
  • "message": "string",
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Get workspace by Id

Get a single workspace

path Parameters
workspaceId
required
string

Numeric ID of the account to get

Responses

Response samples

Content type
application/json
{
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "workspace_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "contracts": [
    ],
  • "name": "string",
  • "use_type": "TEST"
}

Edit workspace

Update a single workspace

path Parameters
workspaceId
required
string

Numeric ID of the account to get

Request Body schema: application/json
org_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

workspace_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

created_at
string <date-time>
id
string
metadata
object
updated_at
string <date-time>
Array of objects (Contracts)
name
required
string
use_type
string
Enum: "TEST" "SYNGENTA_DIGITAL_GROWER" "SYNGENTA_DIGITAL_DISTRIBUTION" "SYNGENTA_SEEDS" "SYNGENTA_CP" "WS-DEFAULT"

Responses

Request samples

Content type
application/json
{
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "workspace_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "contracts": [
    ],
  • "name": "string",
  • "use_type": "TEST"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "metadata": { },
  • "use_type": "TEST"
}

Get Accounts from its default workspaces ids

Get Accounts by their default workspace ids. If an id does not exist, it does not return it.

query Parameters
include_deleted
boolean

Return only non-deleted or both deleted and non-deleted accounts

page
integer

Requested page number. Starting from zero. Default is zero.

size
integer

Requested page size. Default is unpaged

Request Body schema: application/json
ids
Array of objects <uuid> (UUID Canonical textual representation)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "total_pages": 1,
  • "total_elements": 1,
  • "last": true,
  • "first": true,
  • "sort": {
    },
  • "number_of_elements": 1,
  • "size": 2000,
  • "number": 0,
  • "empty": false
}

Get Workspaces

Get all workspaces

query Parameters
size
integer

Number of workspaces to return

last_key
string

Id of the last workspace returned by the previous query

name
string

Filter accounts containing this name

country
string

Filter accounts containing this country

app_id
string

Filter accounts containing this appId

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Create a new workspace

Create a workspace

query Parameters
country
string

Filter accounts containing this country

set_workspace_owner
boolean

Set Workspace Owner role to current user or not

Request Body schema: application/json
name
required
string
id
string
Array of objects (Contracts)
metadata
object
use_type
required
string
Enum: "TEST" "SYNGENTA_DIGITAL_GROWER" "SYNGENTA_DIGITAL_DISTRIBUTION" "SYNGENTA_SEEDS" "SYNGENTA_CP" "WS-DEFAULT"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "contracts": [
    ],
  • "metadata": { },
  • "use_type": "TEST"
}

Response samples

Content type
application/json
{
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "workspace_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "metadata": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "contracts": [
    ],
  • "name": "string",
  • "use_type": "TEST"
}

Notes Attachments

Get Attachment Details

Get Attachment Details

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{}

Delete an attachment

Delete an attachment

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Create a new Attachment

Create a new Attachment

Request Body schema: application/json
extension
required
string

Allowed extensions: mp4, mov, wmv, m4a, mp3, amr, aac, jpg, png, gif, pdf, doc, txt

metadata
string

Metadata from file. Source (gallery or camera) or other metadata file

size
required
number

Size in bytes

Responses

Request samples

Content type
application/json
{
  • "extension": "video.mp4",
  • "metadata": "source:gallery",
  • "size": "1024 bytes (1mb)"
}

Response samples

Content type
application/json
{}

Notes

Get Notes by context attribute

There are two special values for the parameter context to search notes, null and * Ex: property:cf4ff242-674c-42a7-837d-f52a82fd2648/parent_region:null/field:*, This example should return all notes without the key parent_region and with any value at the key field. The dates format (YYYY-MM-DD HH:MM:SS)

query Parameters
offset
integer
size
integer
Request Body schema: application/json
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

context
required
string (Note context value)

A key:value collection with the format: key:value/key:value/key:value/key:value/ ... There are two keywords previously defined: field and property. The app client can use any value as a key to customize.

start_date
string

format (YYYY-MM-DD HH:MM:SS)

end_date
string

format (YYYY-MM-DD HH:MM:SS)

tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "context": "property:cf4ff242-674c-42a7-837d-f52a82fd2648/field:daf2d4f8-6029-4035-b571-01ce03f4b422",
  • "start_date": "2023-01-20 21:00:00",
  • "end_date": "2023-01-31 00:00:00",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Notes created by a specific user

Get Notes created by a specific user

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
last_key
string
size
integer
org_id
required
object <uuid> (UUID Canonical textual representation)
Example: org_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

tag
Array of strings

If it's more than one value the values should be sent separately. Ex: &tag=VALUE1&tag=VALUE2&tag=VALUE3.

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Notes by field ID in a time interval

Get Notes by field ID in a time interval

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
last_key
string
size
integer
start_date
string
end_date
string
org_id
required
object <uuid> (UUID Canonical textual representation)
Example: org_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

tag
Array of strings

If it's more than one value the values should be sent separately. Ex: &tag=VALUE1&tag=VALUE2&tag=VALUE3.

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Notes by fields in a time interval

Get Notes by fields in a time interval

query Parameters
last_key
string
size
integer
Request Body schema: application/json
fields
required
Array of strings
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

start_date
string
end_date
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "start_date": "string",
  • "end_date": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Note Details

Get Note Details

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "namespace": "Namespace Example",
  • "source": "string",
  • "created_by": "string",
  • "author": "John Doe",
  • "note": "Short description explaining something.",
  • "date": "string",
  • "type": "Land Annotation",
  • "context": "property:cf4ff242-674c-42a7-837d-f52a82fd2648/field:daf2d4f8-6029-4035-b571-01ce03f4b422",
  • "user_location": {
    },
  • "manual_location": {
    },
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "note_attachment": [],
  • "note_tag": [
    ],
  • "external_id": "string"
}

Edit Note with specified Id

Edit Note with specified Id. Obs: if the client wants to delete all the Tags and/or the Attachemnt, it should send the attribute with an empty array (the value [])

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Request Body schema: application/json
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

namespace
required
string
source
required
string
created_by
string
author
string
note
required
string
type
string (NoteType)
Enum: "Land Annotation" "Comment"
context
required
string (Note context value)

A key:value collection with the format: key:value/key:value/key:value/key:value/ ... There are two keywords previously defined: field and property. The app client can use any value as a key to customize.

user_location
string
manual_location
string
parent_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

note_attachment
Array of objects <uuid> (UUID Canonical textual representation)
note_tag
Array of strings
external_id
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "namespace": "Cropzone Example",
  • "source": "string",
  • "created_by": "string",
  • "author": "John Doe",
  • "note": "Short description explaining something.",
  • "type": "Land Annotation",
  • "context": "property:cf4ff242-674c-42a7-837d-f52a82fd2648/field:daf2d4f8-6029-4035-b571-01ce03f4b422",
  • "user_location": "-18.161360,-47.943459",
  • "manual_location": "-18.161360,-47.943459",
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "note_attachment": [
    ],
  • "note_tag": [
    ],
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "namespace": "Namespace Example",
  • "source": "string",
  • "created_by": "string",
  • "author": "John Doe",
  • "note": "Short description explaining something.",
  • "date": "string",
  • "type": "Land Annotation",
  • "context": "property:cf4ff242-674c-42a7-837d-f52a82fd2648/field:daf2d4f8-6029-4035-b571-01ce03f4b422",
  • "user_location": {
    },
  • "manual_location": {
    },
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "note_attachment": [],
  • "note_tag": [
    ],
  • "external_id": "string"
}

Delete a note

Delete a note

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Get Notes by namespace

Get Notes by namespace

query Parameters
last_key
string
size
integer
Request Body schema: application/json
org_id
required
string
namespace
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "namespace": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Notes by nearest points

Get Notes by nearest points

query Parameters
offset
string
size
integer
Request Body schema: application/json
org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

latitude
required
string
longitude
required
string
source
required
string
radius
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "latitude": "-18.161360",
  • "longitude": "-47.943459",
  • "source": "string",
  • "radius": "10",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Notes by property in a time interval

Get Notes by property in a time interval

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
org_id
required
object <uuid> (UUID Canonical textual representation)
Example: org_id=bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

last_key
string
size
integer
start_date
string
end_date
string
tag
Array of strings

If it's more than one value the values should be sent separately. Ex: &tag=VALUE1&tag=VALUE2&tag=VALUE3.

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Notes by source

Get Notes by source

query Parameters
last_key
string
size
integer
Request Body schema: application/json
source
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "source": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Create a new Note

Create a new Note

Request Body schema: application/json
id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

org_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

namespace
required
string
source
required
string
created_by
required
string
author
required
string
note
required
string
date
required
string
type
required
string (NoteType)
Enum: "Land Annotation" "Comment"
context
required
string (Note context value)

A key:value collection with the format: key:value/key:value/key:value/key:value/ ... There are two keywords previously defined: field and property. The app client can use any value as a key to customize.

object (Geojson object)
object (Geojson object)
parent_id
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Array of objects (Note Attachment Object)
note_tag
Array of strings
external_id
string

Responses

Request samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "namespace": "Namespace Example",
  • "source": "string",
  • "created_by": "string",
  • "author": "John Doe",
  • "note": "Short description explaining something.",
  • "date": "string",
  • "type": "Land Annotation",
  • "context": "property:cf4ff242-674c-42a7-837d-f52a82fd2648/field:daf2d4f8-6029-4035-b571-01ce03f4b422",
  • "user_location": {
    },
  • "manual_location": {
    },
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "note_attachment": [],
  • "note_tag": [
    ],
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "namespace": "Namespace Example",
  • "source": "string",
  • "created_by": "string",
  • "author": "John Doe",
  • "note": "Short description explaining something.",
  • "date": "string",
  • "type": "Land Annotation",
  • "context": "property:cf4ff242-674c-42a7-837d-f52a82fd2648/field:daf2d4f8-6029-4035-b571-01ce03f4b422",
  • "user_location": {
    },
  • "manual_location": {
    },
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "note_attachment": [],
  • "note_tag": [
    ],
  • "external_id": "string"
}

Notes Tags

Get Notes by tag ID

Get Notes by tag ID

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

query Parameters
last_key
string
size
integer

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get Notes by tags

Get Notes by tags

query Parameters
last_key
string
size
integer
Request Body schema: application/json
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Get all Tags

Get all Tags

query Parameters
last_key
string
size
integer

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Delete a tag

Delete a tag

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Create a new Tag

Create a new Tag

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "tag": "string"
}

Notes Comments

Get Note Comment Details

Get Note Comment Details

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "source": "string",
  • "created_by": "string",
  • "author": "John Doe",
  • "created_at": "string",
  • "note": "Short description explaining something.",
  • "date": "string",
  • "type": "Comment",
  • "context": "property:cf4ff242-674c-42a7-837d-f52a82fd2648/field:daf2d4f8-6029-4035-b571-01ce03f4b422",
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Delete a Note Comment

Delete a Note Comment

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Get Note Comments by Parent ID

Get Note Comment by Parent ID

path Parameters
id
required
object <uuid> (UUID Canonical textual representation)
Example: bf1ac975-482e-405d-a9f0-efe8ad7d7481

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Response samples

Content type
application/json
{
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number_of_elements": 0,
  • "pageable": {
    },
  • "content": [
    ]
}

Create a new Note Comment

Create a new Note Comment

Request Body schema: application/json
id
string
source
required
string
created_by
required
string
author
required
string
note
required
string
date
required
string
type
required
string

A Note Comment must have Comment type.

parent_id
required
object <uuid> (UUID Canonical textual representation)

A v4 UUID, represented in its canonical textual form (hexadecimal, lowercase, 8-4-4-4-12 groups separated by a dash (-)).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "source": "string",
  • "created_by": "string",
  • "author": "John Doe",
  • "note": "Short description explaining something.",
  • "date": "string",
  • "type": "Comment",
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "source": "string",
  • "created_by": "string",
  • "author": "John Doe",
  • "created_at": "string",
  • "note": "Short description explaining something.",
  • "date": "string",
  • "type": "Comment",
  • "context": "property:cf4ff242-674c-42a7-837d-f52a82fd2648/field:daf2d4f8-6029-4035-b571-01ce03f4b422",
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}

Edit Note Comment with specified Id

Edit Note Comment with specified Id

Request Body schema: application/json
id
required
string
source
required
string
author
string
note
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "source": "string",
  • "author": "John Doe",
  • "note": "Short description explaining something."
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "org_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481",
  • "source": "string",
  • "created_by": "string",
  • "author": "John Doe",
  • "created_at": "string",
  • "note": "Short description explaining something.",
  • "date": "string",
  • "type": "Comment",
  • "context": "property:cf4ff242-674c-42a7-837d-f52a82fd2648/field:daf2d4f8-6029-4035-b571-01ce03f4b422",
  • "parent_id": "bf1ac975-482e-405d-a9f0-efe8ad7d7481"
}