cropwise-platform-sdk

CropwisePlatformSdk - the Ruby gem for the Syngenta Base Platform API

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.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.16.0
  • Package version: 1.16.0.pre.alpha1
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build cropwise-platform-sdk.gemspec

Then either install the gem locally:

gem install ./cropwise-platform-sdk-1.16.0.pre.alpha1.gem

(for development, run gem install --dev ./cropwise-platform-sdk-1.16.0.pre.alpha1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'cropwise-platform-sdk', '~> 1.16.0.pre.alpha1'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'cropwise-platform-sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'cropwise-platform-sdk'

api_instance = CropwisePlatformSdk::AccountApi.new
opts = {
  last_key: 'last_key_example', # String | 
  size: 56, # Integer | 
  uuid_list_model: CropwisePlatformSdk::UUIDListModel.new # UUIDListModel | 
}

begin
  #Batch get account roles by ids
  result = api_instance.batch_get_accunt_roles_by_ids(opts)
  p result
rescue CropwisePlatformSdk::ApiError => e
  puts "Exception when calling AccountApi->batch_get_accunt_roles_by_ids: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.base.cropwise.com

Class Method HTTP request Description
CropwisePlatformSdk::AccountApi batch_get_accunt_roles_by_ids POST /v2/accounts/ids/roles Batch get account roles by ids
CropwisePlatformSdk::AccountApi delete_account_by_id DELETE /v2/accounts/account_id Delete an Account
CropwisePlatformSdk::AccountApi delete_account_photo_by_account_id DELETE /v2/accounts/account_id/photo Remove Account Photo
CropwisePlatformSdk::AccountApi delete_v2_accounts_account_id_support DELETE /v2/accounts/account_id/support Remove SUPPORT Authority
CropwisePlatformSdk::AccountApi edit_account_by_account_id PUT /v2/accounts/account_id Edit Account
CropwisePlatformSdk::AccountApi get_account_by_account_id GET /v2/accounts/account_id Get Account By Id
CropwisePlatformSdk::AccountApi get_account_roles_by_id GET /v2/accounts/account_id/roles Get Account's Roles
CropwisePlatformSdk::AccountApi get_accounts_by_accounts_id POST /v2/accounts/ids Get Accounts by Ids
CropwisePlatformSdk::AccountApi get_accounts_by_defualt_workspace_id POST /v2/workspaces/ids/accounts Get Accounts from its default workspaces ids
CropwisePlatformSdk::AccountApi get_accounts_by_orgs_id POST /v2/orgs/ids/accounts Get Orgs' Accounts by Orgs' Ids
CropwisePlatformSdk::AccountApi get_invites_by_orgs_id POST /v2/orgs/ids/invite-status Get Orgs' Invites by Orgs' Ids and its status
CropwisePlatformSdk::AccountApi get_me GET /v2/accounts/me Get current user
CropwisePlatformSdk::AccountApi get_org_accounts_by_org_id GET /v2/orgs/org_id/accounts/ Get Org Accounts
CropwisePlatformSdk::AccountApi get_root_owners_workspace_id POST /v2/workspaces/ids/root-owners Get Root owners from the orgs that the workspace id is linked
CropwisePlatformSdk::AccountApi get_signup_info GET /v2/accounts/signup/info Get information about the email which will signup
CropwisePlatformSdk::AccountApi get_v2_accounts_login_name_phone GET /v2/accounts Get Account by parameters.
CropwisePlatformSdk::AccountApi post_account_photo POST /v2/accounts/account_id/photo Upload Account Photo
CropwisePlatformSdk::AccountApi post_v2_accounts_account_id_authorities_updates POST /v2/accounts/account_id/authorities/updates update authorities
CropwisePlatformSdk::AccountApi post_v2_accounts_account_id_support POST /v2/accounts/account_id/support Give SUPPORT Authority
CropwisePlatformSdk::AccountApi revoke_invite_by_id DELETE /v2/accounts/invitation/id/revoke Revoke Sent Invitation
CropwisePlatformSdk::AccountApi translate_roles_to_legacy_permissions POST /v2/accounts/account_id/roles/legacy-translation Translate Roles to Legacy permissions
CropwisePlatformSdk::AccountApi v2_accounts_by_name_get GET /v2/accounts/by-name Get Account by name.
CropwisePlatformSdk::AccountApi v2_accounts_check_get GET /v2/accounts/check Get If Account exists.
CropwisePlatformSdk::AccountManagementApi post_accounts_recovery_recovery_id POST /v2/accounts/recovery/recovery_id Apply password change
CropwisePlatformSdk::AccountManagementApi post_migration POST /v2/accounts/migration Account Creator for migrating users
CropwisePlatformSdk::AccountManagementApi post_signup POST /v2/accounts/signup Account Creator
CropwisePlatformSdk::AccountManagementApi request_account_recovery POST /v2/accounts/recovery Account recovery mail sender
CropwisePlatformSdk::AccountManagementApi reset_account_password POST /v2/accounts/reset-password Reset password for account
CropwisePlatformSdk::AccountManagementApi send_account_invitation POST /v2/accounts/invitation Send Account Invitation
CropwisePlatformSdk::AppApi create_developer_app POST /v2/apps Developer App Creator
CropwisePlatformSdk::AppApi delete_app_by_id DELETE /v2/apps/app_id
CropwisePlatformSdk::AppApi delete_app_icon_by_app_id DELETE /v2/apps/app_id/icon Remove App Icon
CropwisePlatformSdk::AppApi delete_app_image_by_app_id DELETE /v2/apps/app_id/image Remove App Image
CropwisePlatformSdk::AppApi get_app_icon_by_app_id GET /v2/apps/app_id/icon Get App Icon
CropwisePlatformSdk::AppApi get_app_image_by_app_id GET /v2/apps/app_id/image Get App Image
CropwisePlatformSdk::AppApi get_developer_app_by_id GET /v2/apps/app_id Get Developer App By Id
CropwisePlatformSdk::AppApi get_oauth2_clients_by_app_id GET /v2/apps/app_id/oauth2-clients Get All Oauth2 Clients By App Id
CropwisePlatformSdk::AppApi get_store_app_by_id GET /v2/store/apps/app_id Get App By Id in Store
CropwisePlatformSdk::AppApi get_store_apps GET /v2/store/apps List Apps in Store
CropwisePlatformSdk::AppApi get_store_apps_per_workspace GET /v2/store/workspaces/apps List Apps in Store per workspace
CropwisePlatformSdk::AppApi get_v2_apps GET /v2/apps List Apps
CropwisePlatformSdk::AppApi get_v2_apps_app_id_authorities GET /v2/apps/app_id/authorities Get authorities by application
CropwisePlatformSdk::AppApi get_v2_apps_app_id_info GET /v2/apps/app_id/info Get Basic App Info by Id
CropwisePlatformSdk::AppApi get_v2_apps_authorities GET /v2/apps/authorities Get authorities by application
CropwisePlatformSdk::AppApi get_v2_apps_projects GET /v2/apps/projects List Developer Apps
CropwisePlatformSdk::AppApi get_v2_orgs_org_id_apps GET /v2/orgs/org_id/apps Installed apps for Org
CropwisePlatformSdk::AppApi post_app_icon POST /v2/apps/app_id/icon Upload App Icon
CropwisePlatformSdk::AppApi post_app_image POST /v2/apps/app_id/image Upload App Image
CropwisePlatformSdk::AppApi post_v2_apps_app_id_install POST /v2/apps/app_id/installation App installer
CropwisePlatformSdk::AppApi post_v2_apps_enroll POST /v2/apps/enrollment Enroll an App
CropwisePlatformSdk::AppApi update_developer_app PUT /v2/apps/app_id Update Developer App
CropwisePlatformSdk::AppApi v2_apps_app_id_campaigns_get GET /v2/apps/app_id/campaigns Get Campaigns by app
CropwisePlatformSdk::BillingApi confirmate_contract_payment_id POST /v2/billing/workspaces/workspace_id/contracts/contract_id/confirmation Confirmate a Contract Payment
CropwisePlatformSdk::BillingApi create_payment_intent_by_id POST /v2/billing/workspaces/workspace_id/intent Create a Payment Intent
CropwisePlatformSdk::CampaignsApi delete_campaigns_campaign_id DELETE /v2/campaigns/campaignId Delete Campaign
CropwisePlatformSdk::CampaignsApi delete_v2_campaigns_campaign_id_shareable_link_link_id DELETE /v2/campaigns/campaignId/shareable-link/linkId Delete a Campaign Link by LinkId
CropwisePlatformSdk::CampaignsApi get_campaign_plans_campaign_id POST /v2/campaigns/campaignId/plans Add Plans to Campaigns
CropwisePlatformSdk::CampaignsApi get_campaign_vouchers_campaign_id GET /v2/campaigns/campaignId/vouchers Get Campaign Vouchers
CropwisePlatformSdk::CampaignsApi get_campaigns GET /v2/campaigns Get all campaigns
CropwisePlatformSdk::CampaignsApi get_campaigns_campaign_id GET /v2/campaigns/campaignId Get Campaign By Id
CropwisePlatformSdk::CampaignsApi get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info GET /v2/campaigns/campaignId/shareable-link/linkId/redeem-info Get a redeem info from campaignId and shareable-link
CropwisePlatformSdk::CampaignsApi post_campaign_vouchers_campaign_id POST /v2/campaigns/campaignId/vouchers Add Vouchers to Campaign
CropwisePlatformSdk::CampaignsApi post_campaigns POST /v2/campaigns Create Campaign
CropwisePlatformSdk::CampaignsApi post_v2_campaigns_campaign_id_shareable_link POST /v2/campaigns/campaignId/shareable-link Create a Campaign Link
CropwisePlatformSdk::CampaignsApi post_v2_vouchers_campaign_id_redeem_link_link_id POST /v2/campaigns/campaignId/redeem-link/linkId Redeem Voucher Using a Campaign Link
CropwisePlatformSdk::CampaignsApi put_campaigns_campaign_id PUT /v2/campaigns/campaignId Edit Campaign
CropwisePlatformSdk::CampaignsApi put_v2_campaigns_campaign_id_shareable_link_link_id PUT /v2/campaigns/campaignId/shareable-link/linkId Edit Campaign Link
CropwisePlatformSdk::CampaignsApi toggle_campaigns_campaign_id PUT /v2/campaigns/campaignId/activation-toggle Toggle Campaign Activation
CropwisePlatformSdk::CatalogCropApi delete_v2_catalog_crops_crop_id DELETE /v2/catalog/crops/crop_id Delete a crop
CropwisePlatformSdk::CatalogCropApi get_v2_catalog_crops GET /v2/catalog/crops/crop_id Get Crop By Id
CropwisePlatformSdk::CatalogCropApi post_v2_catalog_crops POST /v2/catalog/crops Create a Crop
CropwisePlatformSdk::CatalogCropApi put_v2_catalog_crops_crop_id PUT /v2/catalog/crops/crop_id Edit Crop
CropwisePlatformSdk::CatalogCropApi v2_catalog_crops_get GET /v2/catalog/crops Get all crops from catalog
CropwisePlatformSdk::CatalogCropEppoApi create_eppo_catalog_crops POST /v2/catalog/eppos Create New Eppo
CropwisePlatformSdk::CatalogCropEppoApi delete_eppo_catalog_crops DELETE /v2/catalog/eppos/eppo_code Delete Eppos
CropwisePlatformSdk::CatalogCropEppoApi edit_eppo_catalog_crops PUT /v2/catalog/eppos/eppo_code Edit an Eppo
CropwisePlatformSdk::CatalogCropEppoApi get_all_eppo_catalog_crops GET /v2/catalog/eppos Get All Eppos
CropwisePlatformSdk::CatalogCropEppoApi get_eppo_catalog_crops GET /v2/catalog/eppos/eppo_code Get Eppo by Code
CropwisePlatformSdk::CatalogCropEppoApi verify_eppo_catalog_crops POST /v2/catalog/eppos/verify Verify Eppos
CropwisePlatformSdk::CatalogCropGrowthScaleApi delete_v2_catalog_growth_scales_id DELETE /v2/catalog/growth-scales/id Delete Growth Scale By Id
CropwisePlatformSdk::CatalogCropGrowthScaleApi get_all_v2_catalog_growth_scales GET /v2/catalog/growth-scales Get All Growth Scales Associated With Org
CropwisePlatformSdk::CatalogCropGrowthScaleApi get_v2_catalog_growth_scales GET /v2/catalog/growth-scales/id Get Growth Scale By Id
CropwisePlatformSdk::CatalogCropGrowthScaleApi get_v2_g_scale_localized GET /v2/catalog/growth-scales/localized-crop Get Growth Scales By Localized Crop
CropwisePlatformSdk::CatalogCropGrowthScaleApi get_v2_g_scale_without_org_id GET /v2/catalog/growth-scales/no-org Get All Growth Scales Without OrgId
CropwisePlatformSdk::CatalogCropGrowthScaleApi get_v2_localizeds_by_growth_scale GET /v2/catalog/growth-scales/id/localized-crops Get all Localized Crops from a growth scale
CropwisePlatformSdk::CatalogCropGrowthScaleApi post_v2_catalog_growth_scale_allocation POST /v2/catalog/growth-scales/allocation Create Growth Scale Allocation
CropwisePlatformSdk::CatalogCropGrowthScaleApi post_v2_catalog_growth_scales POST /v2/catalog/growth-scales Create a Growth Scale
CropwisePlatformSdk::CatalogCropGrowthScaleApi post_v2_growth_scale_with_localized_associate POST /v2/catalog/growth-scales/id/localized-crops Associate a growth scale with localized crops
CropwisePlatformSdk::CatalogCropGrowthScaleApi put_v2_catalog_growth_scales_id PUT /v2/catalog/growth-scales/id Update Growth Scale By Id
CropwisePlatformSdk::CatalogProductApi change_canon_catalog_product_visibility POST /v2/catalog/products/hidden Change the visibility of a canon product for a organization
CropwisePlatformSdk::CatalogProductApi create_custom_catalog_product POST /v2/catalog/products Create a Custom Product in the Catalog
CropwisePlatformSdk::CatalogProductApi delete_custom_catalog_product PUT /v2/catalog/products/product_id Edit a Custom Product in the Catalog
CropwisePlatformSdk::CatalogProductApi delete_custom_catalog_product_0 DELETE /v2/catalog/products/product_id Delete a Custom Product in the Catalog
CropwisePlatformSdk::CatalogProductApi get_canon_catalog_product_country_source GET /v2/catalog/products Get Canon Products in the Catalog
CropwisePlatformSdk::CatalogProductApi get_custom_catalog_product GET /v2/catalog/products/product_id Get a Product in the Catalog
CropwisePlatformSdk::CatalogProductApi get_org_catalog_products GET /v2/catalog/orgs/org_id/products Get an Organization's Product in the Catalog
CropwisePlatformSdk::ContractsApi delete_workspace_contract_entity_workspace_id_contract_id DELETE /v2/workspaces/workspaceId/contracts/contractId/entities Delete contract entities
CropwisePlatformSdk::ContractsApi delete_workspace_contract_workspace_id_contract_id DELETE /v2/workspaces/workspaceId/contracts/contractId Delete Contract
CropwisePlatformSdk::ContractsApi get_contracts_by_appid GET /v2/apps/appId/contracts Get all contracts for an app
CropwisePlatformSdk::ContractsApi get_contracts_by_entitlement GET /v2/workspaces/contracts/by-entitlements Get contracts by entitlements
CropwisePlatformSdk::ContractsApi get_contracts_by_entitlement_ids POST /v2/entitlements/ids/contracts Get contracts by entitlements ids
CropwisePlatformSdk::ContractsApi get_contracts_by_entitlement_keys POST /v2/entitlements/keys/contracts Get contracts by entitlements keys
CropwisePlatformSdk::ContractsApi get_contracts_per_entity_workspace_id_entity_id GET /v2/workspaces/workspaceId/entities/entityId Get contracts by entity
CropwisePlatformSdk::ContractsApi get_v2_contracts_workspace_id_contracts_contract_id GET /v2/workspaces/workspaceId/contracts/contractId Get a Contract
CropwisePlatformSdk::ContractsApi get_workspace_contracts_workspace_id GET /v2/workspaces/workspaceId/contracts Get Contracts By Account
CropwisePlatformSdk::ContractsApi post_v2_contracts_workspace_id_contracts_contract_id_entities POST /v2/workspaces/workspaceId/contracts/contractId/entities Update a Contract Entity
CropwisePlatformSdk::ContractsApi post_workspace_contracts_workspace_id POST /v2/workspaces/workspaceId/contracts Add Contract to Account
CropwisePlatformSdk::ContractsApi put_v2_contracts_workspace_id_contracts_contract_id PUT /v2/workspaces/workspaceId/contracts/contractId Update a Contract
CropwisePlatformSdk::CropApi get_crops GET /v2/crops List crops
CropwisePlatformSdk::CycleApi attach_cycle_seasons POST /v2/cycles/cycleId/seasons Attach/Deattach Cycle's season
CropwisePlatformSdk::CycleApi create_cycle POST /v2/cycles Create a Cycle
CropwisePlatformSdk::CycleApi delete_cycle DELETE /v2/cycles/cycleId Delete a Cycle
CropwisePlatformSdk::CycleApi edit_cycle PUT /v2/cycles/cycleId Edit a Cycle
CropwisePlatformSdk::CycleApi get_cycle GET /v2/cycles/cycleId Get a Cycle
CropwisePlatformSdk::CycleApi get_cycle_season_fields GET /v2/cycles/cycleId/season-fields Get Cycle's season-fields
CropwisePlatformSdk::CycleApi get_cycle_seasons GET /v2/cycles/cycleId/seasons Get Cycle's season
CropwisePlatformSdk::CycleApi get_org_cycles GET /v2/orgs/orgId/cycles List Organization's Cycles
CropwisePlatformSdk::CycleApi get_property_cycles GET /v2/properties/propertyId/cycles List Property's Cycles
CropwisePlatformSdk::EmailTemplateApi delete_email_template_by_id DELETE /v2/email/templates/template_id Delete an EmailTemplate
CropwisePlatformSdk::EmailTemplateApi edit_email_template_by_template_id PUT /v2/email/templates/template_id Edit EmailTemplate
CropwisePlatformSdk::EmailTemplateApi get_template_by_id GET /v2/email/templates/template_id EmailTemplate Details
CropwisePlatformSdk::EmailTemplateApi post_v2_email_template POST /v2/email/templates EmailTemplate
CropwisePlatformSdk::EmailTemplateApi v2_email_templates_attachment_delete DELETE /v2/email/templates/attachment Remove attachment
CropwisePlatformSdk::EmailTemplateApi v2_email_templates_attachment_post POST /v2/email/templates/attachment Upload attachment
CropwisePlatformSdk::EmailTemplateApi v2_email_templates_image_delete DELETE /v2/email/templates/image Remove image
CropwisePlatformSdk::EmailTemplateApi v2_email_templates_image_post POST /v2/email/templates/image Upload image
CropwisePlatformSdk::EmailTemplateApi v2_email_templates_template_id_send_post POST /v2/email/templates/template_id/send send email
CropwisePlatformSdk::EntitlementsApi delete_entitlements DELETE /v2/entitlements/entitlementId Soft Delete a Entitlement
CropwisePlatformSdk::EntitlementsApi get_contracts_by_entitlement GET /v2/workspaces/contracts/by-entitlements Get contracts by entitlements
CropwisePlatformSdk::EntitlementsApi get_contracts_by_entitlement_ids POST /v2/entitlements/ids/contracts Get contracts by entitlements ids
CropwisePlatformSdk::EntitlementsApi get_contracts_by_entitlement_keys POST /v2/entitlements/keys/contracts Get contracts by entitlements keys
CropwisePlatformSdk::EntitlementsApi get_entitlements GET /v2/entitlements/entitlementId Get an Entitlement
CropwisePlatformSdk::EntitlementsApi get_entitlements_by_appid GET /v2/apps/appId/entitlements Get an Entitlements From an App
CropwisePlatformSdk::EntitlementsApi get_entitlements_by_ids POST /v2/entitlements/ids Get Entitlements by Ids
CropwisePlatformSdk::EntitlementsApi post_entitlements POST /v2/entitlements Create a Entitlement
CropwisePlatformSdk::EntitlementsApi put_entitlements_entitlement_id PUT /v2/entitlements/entitlementId Edit Entitlement
CropwisePlatformSdk::EquipmentApi delete_equipment_by_id DELETE /v2/equipments/id
CropwisePlatformSdk::EquipmentApi get_equipment_by_id GET /v2/equipments/id List Equipment By ID
CropwisePlatformSdk::EquipmentApi get_equipments GET /v2/orgs/org_id/equipments List Organization equipments
CropwisePlatformSdk::EquipmentApi get_equipments_by_equipments_id POST /v2/equipments/ids Get Equipments by Ids
CropwisePlatformSdk::EquipmentApi get_equipments_with_extended_attribute GET /v2/orgs/org_id/equipments/extended-search List Organization equipments with filtered extra_attribute
CropwisePlatformSdk::EquipmentApi post_v2_equipments POST /v2/equipments Equipment Creator
CropwisePlatformSdk::EquipmentApi update_equipment_by_id PUT /v2/equipments/id Update Equipment
CropwisePlatformSdk::FieldApi create_field POST /v2/fields Create Field
CropwisePlatformSdk::FieldApi delete_area_history_using_delete DELETE /v2/fields/id/history/version_id Delete Field history by id
CropwisePlatformSdk::FieldApi delete_field_by_id DELETE /v2/fields/id Delete Field By ID
CropwisePlatformSdk::FieldApi edit_field_by_id PUT /v2/fields/id Edit existing Field
CropwisePlatformSdk::FieldApi get_area_history_by_entity_id GET /v2/fields/id/history Field history details by id
CropwisePlatformSdk::FieldApi get_current_season_by_field_id GET /v2/fields/id/current-season Get Current Season by Field Id
CropwisePlatformSdk::FieldApi get_current_season_fields GET /v2/properties/property_id/current-season-fields List of property's season fields
CropwisePlatformSdk::FieldApi get_cycle_season_fields GET /v2/cycles/cycleId/season-fields Get Cycle's season-fields
CropwisePlatformSdk::FieldApi get_field_by_id GET /v2/fields/id Field details
CropwisePlatformSdk::FieldApi get_field_by_version GET /v2/fields/id/versioning Field details by version
CropwisePlatformSdk::FieldApi get_fields GET /v2/fields List fields
CropwisePlatformSdk::FieldApi get_fields_by_field_id POST /v2/fields/ids Get Fields by Ids
CropwisePlatformSdk::FieldApi get_fields_by_property_extended_search GET /v2/properties/property_id/fields/extended-search List property fields with ExtendedAttribute
CropwisePlatformSdk::FieldApi get_fields_geometry_updates GET /v2/properties/property_id/fields/updates Query results and version identifiers of previous updates.
CropwisePlatformSdk::FieldApi get_regions_geometry_updates GET /v2/properties/property_id/regions/updates Query results and version identifiers of previous updates.
CropwisePlatformSdk::FieldApi get_season_fields_by_season_id GET /v2/seasons/season_id/fields List Fields of the Season
CropwisePlatformSdk::FieldApi get_season_fields_by_seasons_ids_and_properties_ids POST /v2/seasons/ids/properties/ids/fields List Seasons Fields of Seasons and Properties
CropwisePlatformSdk::FieldApi get_seasons_by_field_id GET /v2/fields/id/seasons Get Seasons by Field Id
CropwisePlatformSdk::FieldApi post_field_by_version POST /v2/fields/id/versioning Restore field by version
CropwisePlatformSdk::FieldApi post_fields_geometry_updates POST /v2/properties/property_id/fields/updates Performs field geometry updates
CropwisePlatformSdk::FieldApi season_land_batch_updates POST /v2/seasons/land/updates Perform batch of operations related to each Season and land (Properties and Fields)
CropwisePlatformSdk::FieldApi season_land_updates POST /v2/seasons/season_id/land/updates Perform a batch of operations related to Season and land (Properties and Fields)
CropwisePlatformSdk::FieldGeometryUpdatesApi post_fields_geometry_updates POST /v2/properties/property_id/fields/updates Performs field geometry updates
CropwisePlatformSdk::LegalDocumentsApi delete_legal_documents_legal_document_id DELETE /v2/legal_documents/legalDocumentId Delete Legal Document
CropwisePlatformSdk::LegalDocumentsApi get_legal_documents GET /v2/legal_documents/all List all Legal Documents
CropwisePlatformSdk::LegalDocumentsApi get_legal_documents_by_location GET /v2/legal_documents/location/locationName List all Legal Documents Filtering by Location
CropwisePlatformSdk::LegalDocumentsApi get_legal_documents_legal_document_id GET /v2/legal_documents/legalDocumentId Get Legal Document by Id
CropwisePlatformSdk::LegalDocumentsApi get_unsigned_legal_documents GET /v2/legal_documents/unsigned Get all unsigned documents
CropwisePlatformSdk::LegalDocumentsApi get_user_legal_documents GET /v2/legal_documents List User Legal Document Signatures
CropwisePlatformSdk::LegalDocumentsApi post_legal_documents POST /v2/legal_documents Create a new Legal Document
CropwisePlatformSdk::LegalDocumentsApi post_legal_documents_sign POST /v2/legal_documents/sign Sign a list of Legal Documents
CropwisePlatformSdk::LegalDocumentsApi put_legal_documents_legal_document_id PUT /v2/legal_documents/legalDocumentId
CropwisePlatformSdk::LicensingApi get_licensingstatus GET /v2/licensing/status Licensing Status
CropwisePlatformSdk::NotesApi v2_notes_context_post POST /v2/notes/context Get Notes by context attribute
CropwisePlatformSdk::NotesApi v2_notes_created_by_id_get GET /v2/notes/created-by/id Get Notes created by a specific user
CropwisePlatformSdk::NotesApi v2_notes_fields_id_get GET /v2/notes/fields/id Get Notes by field ID in a time interval
CropwisePlatformSdk::NotesApi v2_notes_fields_post POST /v2/notes/fields Get Notes by fields in a time interval
CropwisePlatformSdk::NotesApi v2_notes_id_delete DELETE /v2/notes/id Delete a note
CropwisePlatformSdk::NotesApi v2_notes_id_get GET /v2/notes/id Get Note Details
CropwisePlatformSdk::NotesApi v2_notes_id_put PUT /v2/notes/id Edit Note with specified Id
CropwisePlatformSdk::NotesApi v2_notes_namespace_post POST /v2/notes/namespace Get Notes by namespace
CropwisePlatformSdk::NotesApi v2_notes_nearest_points_post POST /v2/notes/nearest-points Get Notes by nearest points
CropwisePlatformSdk::NotesApi v2_notes_post POST /v2/notes Create a new Note
CropwisePlatformSdk::NotesApi v2_notes_property_id_get GET /v2/notes/property/id Get Notes by property in a time interval
CropwisePlatformSdk::NotesApi v2_notes_source_post POST /v2/notes/source Get Notes by source
CropwisePlatformSdk::NotesAttachmentsApi v2_notes_attachments_id_delete DELETE /v2/notes/attachments/id Delete an attachment
CropwisePlatformSdk::NotesAttachmentsApi v2_notes_attachments_id_get GET /v2/notes/attachments/id Get Attachment Details
CropwisePlatformSdk::NotesAttachmentsApi v2_notes_attachments_post POST /v2/notes/attachments Create a new Attachment
CropwisePlatformSdk::NotesCommentsApi v2_notes_comments_id_delete DELETE /v2/notes/comments/id Delete a Note Comment
CropwisePlatformSdk::NotesCommentsApi v2_notes_comments_id_get GET /v2/notes/comments/id Get Note Comment Details
CropwisePlatformSdk::NotesCommentsApi v2_notes_comments_parent_id_get GET /v2/notes/comments/parent/id Get Note Comments by Parent ID
CropwisePlatformSdk::NotesCommentsApi v2_notes_comments_post POST /v2/notes/comments Create a new Note Comment
CropwisePlatformSdk::NotesCommentsApi v2_notes_comments_put PUT /v2/notes/comments Edit Note Comment with specified Id
CropwisePlatformSdk::NotesTagsApi v2_notes_tags_get GET /v2/notes/tags Get all Tags
CropwisePlatformSdk::NotesTagsApi v2_notes_tags_id_delete DELETE /v2/notes/tags/id Delete a tag
CropwisePlatformSdk::NotesTagsApi v2_notes_tags_id_notes_get GET /v2/notes/tags/id/notes Get Notes by tag ID
CropwisePlatformSdk::NotesTagsApi v2_notes_tags_id_post POST /v2/notes/tags/id Create a new Tag
CropwisePlatformSdk::NotesTagsApi v2_notes_tags_post POST /v2/notes/tags Get Notes by tags
CropwisePlatformSdk::OrganizationApi create_org POST /v2/orgs Organization Creator
CropwisePlatformSdk::OrganizationApi delete_org_by_id DELETE /v2/orgs/org_id
CropwisePlatformSdk::OrganizationApi delete_org_picture_by_org_id DELETE /v2/orgs/org_id/picture Remove Organization Photo
CropwisePlatformSdk::OrganizationApi delete_worker_by_id DELETE /v2/orgs/orgId/workers/id
CropwisePlatformSdk::OrganizationApi get_accounts_by_orgs_id POST /v2/orgs/ids/accounts Get Orgs' Accounts by Orgs' Ids
CropwisePlatformSdk::OrganizationApi get_allowed_orgs GET /v2/orgs List allowed Organizations
CropwisePlatformSdk::OrganizationApi get_allowed_orgs_extended_search GET /v2/orgs/extended-search List allowed Organizations with filtered extra_attribute
CropwisePlatformSdk::OrganizationApi get_equipments GET /v2/orgs/org_id/equipments List Organization equipments
CropwisePlatformSdk::OrganizationApi get_equipments_with_extended_attribute GET /v2/orgs/org_id/equipments/extended-search List Organization equipments with filtered extra_attribute
CropwisePlatformSdk::OrganizationApi get_invite_status_by_org GET /v2/orgs/org_id/invite-status List Invitation Statuses for an Organization
CropwisePlatformSdk::OrganizationApi get_invites_by_orgs_id POST /v2/orgs/ids/invite-status Get Orgs' Invites by Orgs' Ids and its status
CropwisePlatformSdk::OrganizationApi get_org_accounts_by_org_id GET /v2/orgs/org_id/accounts/ Get Org Accounts
CropwisePlatformSdk::OrganizationApi get_org_by_id GET /v2/orgs/org_id Organization Details
CropwisePlatformSdk::OrganizationApi get_org_cycles GET /v2/orgs/orgId/cycles List Organization's Cycles
CropwisePlatformSdk::OrganizationApi get_org_picture_by_org_id GET /v2/orgs/org_id/picture Get Organization Photo
CropwisePlatformSdk::OrganizationApi get_orgs_by_orgs_id POST /v2/orgs/ids Get Orgs by Ids
CropwisePlatformSdk::OrganizationApi get_products_by_org_id GET /v2/orgs/org_id/products List Organization Products
CropwisePlatformSdk::OrganizationApi get_properties_by_org GET /v2/orgs/org_id/properties List Organization properties
CropwisePlatformSdk::OrganizationApi get_properties_by_org_extended_search GET /v2/orgs/org_id/properties/extended-search List Organization properties with filtered extra_attribute
CropwisePlatformSdk::OrganizationApi get_properties_by_orgs_id POST /v2/orgs/ids/properties Get Orgs' Properties by Orgs' Ids
CropwisePlatformSdk::OrganizationApi get_root_owners_workspace_id POST /v2/workspaces/ids/root-owners Get Root owners from the orgs that the workspace id is linked
CropwisePlatformSdk::OrganizationApi get_seasons_by_org GET /v2/orgs/org_id/seasons List Organization seasons
CropwisePlatformSdk::OrganizationApi get_seasons_by_org_with_extended_attribute GET /v2/orgs/org_id/seasons/extended-search List Organization seasons with filtered extra_attribute
CropwisePlatformSdk::OrganizationApi get_seasons_by_orgs_id POST /v2/orgs/ids/seasons Get Orgs' Seasons by Orgs' Ids
CropwisePlatformSdk::OrganizationApi get_tasks_by_organization POST /v2/orgs/org_id/tasks Get Task By Organization
CropwisePlatformSdk::OrganizationApi get_tasks_extended_search GET /v2/orgs/org_id/tasks/extended-search List Organization Tasks with filtered extra_attribute
CropwisePlatformSdk::OrganizationApi get_v2_orgs_org_id_apps GET /v2/orgs/org_id/apps Installed apps for Org
CropwisePlatformSdk::OrganizationApi get_worker GET /v2/orgs/orgId/workers/id Get worker
CropwisePlatformSdk::OrganizationApi get_workers GET /v2/orgs/org_id/workers List Organization Workers
CropwisePlatformSdk::OrganizationApi get_workers_by_org_id_and_properties_ids POST /v2/orgs/org_id/properties/ids/workers List Organization Workers by Property Id and Name
CropwisePlatformSdk::OrganizationApi get_workers_extended_search GET /v2/orgs/org_id/workers/extended-search List Organization Workers with filtered extra_attribute
CropwisePlatformSdk::OrganizationApi post_org_picture POST /v2/orgs/org_id/picture Upload Organization Photo
CropwisePlatformSdk::OrganizationApi post_worker POST /v2/orgs/orgId/workers Create worker
CropwisePlatformSdk::OrganizationApi update_org_by_id PUT /v2/orgs/org_id Organization Updater
CropwisePlatformSdk::OrganizationApi update_worker PUT /v2/orgs/orgId/workers/id Update worker
CropwisePlatformSdk::OrganizationApi v2_orgs_org_id_tasks_get GET /v2/orgs/org_id/tasks Get task by organization
CropwisePlatformSdk::PlansApi delete_plans_plan_id DELETE /v2/plans/planId Delete Plan
CropwisePlatformSdk::PlansApi get_apps_app_idplans GET /v2/apps/appId/plans Get Plans By App
CropwisePlatformSdk::PlansApi get_campaigns_from_plan GET /v2/plans/planId/campaigns Get Campaigns of plans
CropwisePlatformSdk::PlansApi get_plans GET /v2/plans Get All Plans
CropwisePlatformSdk::PlansApi get_plans_plan_id GET /v2/plans/planId Get Plan by Id
CropwisePlatformSdk::PlansApi get_v2_plans_plan_id_accounts GET /v2/plans/planId/accounts Get Accounts of Plan
CropwisePlatformSdk::PlansApi get_v2_plans_plan_id_contracts GET /v2/plans/planId/contracts Get Contracts By Plan
CropwisePlatformSdk::PlansApi post_plans POST /v2/plans Create a new Plan
CropwisePlatformSdk::PlansApi put_plans_plan_id PUT /v2/plans/planId Edit Plan
CropwisePlatformSdk::PolicyApi get_policies_by_context GET /v2/policies/context Get policies by Context
CropwisePlatformSdk::PolicyApi get_policy_by_context_and_id GET /v2/policies/context/policyId Get policy by Context and Id
CropwisePlatformSdk::ProductApi delete_product_by_id DELETE /v2/products/id
CropwisePlatformSdk::ProductApi get_product GET /v2/products/id Get a Product
CropwisePlatformSdk::ProductApi get_products GET /v2/products List products
CropwisePlatformSdk::ProductApi get_products_by_org_id GET /v2/orgs/org_id/products List Organization Products
CropwisePlatformSdk::ProductApi post_product POST /v2/products Create Product
CropwisePlatformSdk::ProductApi update_product PUT /v2/products/id Update product
CropwisePlatformSdk::PropertyApi create_property POST /v2/properties Create property
CropwisePlatformSdk::PropertyApi delete_property_by_id DELETE /v2/properties/property_id Delete Property By ID
CropwisePlatformSdk::PropertyApi edit_property_by_id PUT /v2/properties/property_id Edit existing Property
CropwisePlatformSdk::PropertyApi get_current_season_fields GET /v2/properties/property_id/current-season-fields List of property's season fields
CropwisePlatformSdk::PropertyApi get_fields_by_property GET /v2/properties/property_id/fields List property fields
CropwisePlatformSdk::PropertyApi get_fields_by_property_extended_search GET /v2/properties/property_id/fields/extended-search List property fields with ExtendedAttribute
CropwisePlatformSdk::PropertyApi get_fields_history_by_property GET /v2/properties/property_id/fields/history List property fields history
CropwisePlatformSdk::PropertyApi get_properties_by_ids POST /v2/properties/ids Get Properties By Ids
CropwisePlatformSdk::PropertyApi get_properties_by_org GET /v2/orgs/org_id/properties List Organization properties
CropwisePlatformSdk::PropertyApi get_properties_by_org_extended_search GET /v2/orgs/org_id/properties/extended-search List Organization properties with filtered extra_attribute
CropwisePlatformSdk::PropertyApi get_properties_by_orgs_id POST /v2/orgs/ids/properties Get Orgs' Properties by Orgs' Ids
CropwisePlatformSdk::PropertyApi get_property_by_id GET /v2/properties/property_id Property Details
CropwisePlatformSdk::PropertyApi get_property_cycles GET /v2/properties/propertyId/cycles List Property's Cycles
CropwisePlatformSdk::PropertyApi get_region_tree_by_property_id GET /v2/properties/propertyId/region-tree List properties regionTree
CropwisePlatformSdk::PropertyApi get_regions_by_property_id GET /v2/properties/propertyId/regions List regions
CropwisePlatformSdk::PropertyApi get_regions_history_by_property_id GET /v2/properties/propertyId/regions/history List regions history
CropwisePlatformSdk::PropertyApi get_season_areas_by_property_id_and_updated_since GET /v2/properties/property_id/season-areas-updates List season areas updates since last update
CropwisePlatformSdk::PropertyApi get_season_fields_by_seasons_ids_and_properties_ids POST /v2/seasons/ids/properties/ids/fields List Seasons Fields of Seasons and Properties
CropwisePlatformSdk::PropertyApi get_season_properties_by_season_id GET /v2/seasons/season_id/properties List Properties of the Season
CropwisePlatformSdk::PropertyApi get_seasons_by_property GET /v2/properties/property_id/seasons List property seasons
CropwisePlatformSdk::PropertyApi get_tasks_by_property GET /v2/properties/property_id/tasks List property tasks
CropwisePlatformSdk::PropertyApi get_tasks_by_property_extended_search GET /v2/properties/property_id/tasks/extended-search List property tasks with filtered extra_attribute
CropwisePlatformSdk::PropertyApi get_workers_by_org_id_and_properties_ids POST /v2/orgs/org_id/properties/ids/workers List Organization Workers by Property Id and Name
CropwisePlatformSdk::PropertyApi season_land_batch_updates POST /v2/seasons/land/updates Perform batch of operations related to each Season and land (Properties and Fields)
CropwisePlatformSdk::PropertyApi season_land_updates POST /v2/seasons/season_id/land/updates Perform a batch of operations related to Season and land (Properties and Fields)
CropwisePlatformSdk::RegionApi delete_region_by_id DELETE /v2/regions/id Delete Region By ID
CropwisePlatformSdk::RegionApi delete_region_history_using_delete DELETE /v2/regions/id/history/version_id Delete Region history by id
CropwisePlatformSdk::RegionApi edit_region_by_id PUT /v2/regions/id Edit existing Region
CropwisePlatformSdk::RegionApi get_fields_by_region GET /v2/regions/regionId/fields List fields by regions
CropwisePlatformSdk::RegionApi get_region_by_id GET /v2/regions/id Region details
CropwisePlatformSdk::RegionApi get_region_history_by_entity_id GET /v2/regions/id/history Region history details by id
CropwisePlatformSdk::RegionApi get_region_tree GET /v2/regions/regionId/region-tree List regionTree
CropwisePlatformSdk::RegionApi get_regions_by_parent_region GET /v2/regions/regionId/parent List regions by parent
CropwisePlatformSdk::RegionApi get_regions_by_property_id_extended_search GET /v2/properties/propertyId/regions/extended-search List regions with Extra Attribute
CropwisePlatformSdk::RegionApi get_regions_by_region_id GET /v2/regions/regionId/regions List regions
CropwisePlatformSdk::RegionApi get_regions_ids POST /v2/regions/ids Get all regions by its ids
CropwisePlatformSdk::RegionApi post_regions_geometry_updates POST /v2/properties/property_id/regions/updates Performs region geometry updates
CropwisePlatformSdk::RegionApi post_v2_regions POST /v2/regions Region
CropwisePlatformSdk::RoleApi batch_get_accunt_roles_by_ids POST /v2/accounts/ids/roles Batch get account roles by ids
CropwisePlatformSdk::RoleApi get_account_roles_by_id GET /v2/accounts/account_id/roles Get Account's Roles
CropwisePlatformSdk::SeasonApi attach_cycle_seasons POST /v2/cycles/cycleId/seasons Attach/Deattach Cycle's season
CropwisePlatformSdk::SeasonApi create_season POST /v2/seasons Season Creator
CropwisePlatformSdk::SeasonApi delete_season_by_id DELETE /v2/seasons/season_id
CropwisePlatformSdk::SeasonApi get_current_season_by_field_id GET /v2/fields/id/current-season Get Current Season by Field Id
CropwisePlatformSdk::SeasonApi get_cycle_seasons GET /v2/cycles/cycleId/seasons Get Cycle's season
CropwisePlatformSdk::SeasonApi get_season_by_id GET /v2/seasons/season_id Season Details
CropwisePlatformSdk::SeasonApi get_season_fields_by_season_id GET /v2/seasons/season_id/fields List Fields of the Season
CropwisePlatformSdk::SeasonApi get_season_fields_by_seasons_ids_and_properties_ids POST /v2/seasons/ids/properties/ids/fields List Seasons Fields of Seasons and Properties
CropwisePlatformSdk::SeasonApi get_season_properties_by_season_id GET /v2/seasons/season_id/properties List Properties of the Season
CropwisePlatformSdk::SeasonApi get_seasons_by_field_id GET /v2/fields/id/seasons Get Seasons by Field Id
CropwisePlatformSdk::SeasonApi get_seasons_by_ids POST /v2/seasons/ids Get Seasons by Ids
CropwisePlatformSdk::SeasonApi get_seasons_by_org GET /v2/orgs/org_id/seasons List Organization seasons
CropwisePlatformSdk::SeasonApi get_seasons_by_org_with_extended_attribute GET /v2/orgs/org_id/seasons/extended-search List Organization seasons with filtered extra_attribute
CropwisePlatformSdk::SeasonApi get_seasons_by_orgs_id POST /v2/orgs/ids/seasons Get Orgs' Seasons by Orgs' Ids
CropwisePlatformSdk::SeasonApi get_seasons_by_property GET /v2/properties/property_id/seasons List property seasons
CropwisePlatformSdk::SeasonApi season_land_batch_updates POST /v2/seasons/land/updates Perform batch of operations related to each Season and land (Properties and Fields)
CropwisePlatformSdk::SeasonApi season_land_updates POST /v2/seasons/season_id/land/updates Perform a batch of operations related to Season and land (Properties and Fields)
CropwisePlatformSdk::SeasonApi update_season_by_id PUT /v2/seasons/season_id Season Updater
CropwisePlatformSdk::StoreApi get_store_app_by_id GET /v2/store/apps/app_id Get App By Id in Store
CropwisePlatformSdk::StoreApi get_store_apps GET /v2/store/apps List Apps in Store
CropwisePlatformSdk::StoreApi get_store_apps_per_workspace GET /v2/store/workspaces/apps List Apps in Store per workspace
CropwisePlatformSdk::TaskApi delete_task_by_id DELETE /v2/tasks/task_id Delete task
CropwisePlatformSdk::TaskApi delete_task_comment_by_id DELETE /v2/tasks/comments/comment_id Delete Comment by Id
CropwisePlatformSdk::TaskApi get_task_by_id GET /v2/tasks/task_id Task Details
CropwisePlatformSdk::TaskApi get_tasks_by_organization POST /v2/orgs/org_id/tasks Get Task By Organization
CropwisePlatformSdk::TaskApi get_tasks_by_property GET /v2/properties/property_id/tasks List property tasks
CropwisePlatformSdk::TaskApi get_tasks_by_property_extended_search GET /v2/properties/property_id/tasks/extended-search List property tasks with filtered extra_attribute
CropwisePlatformSdk::TaskApi get_v2_tasks_categories GET /v2/tasks/categories Get Task Categories
CropwisePlatformSdk::TaskApi get_v2_tasks_status GET /v2/tasks/status Get Task Status
CropwisePlatformSdk::TaskApi post_v2_tasks POST /v2/tasks Task Creator
CropwisePlatformSdk::TaskApi post_v2_tasks_task_id_comments POST /v2/tasks/task_id/comments Post comment into Task
CropwisePlatformSdk::TaskApi post_v2_tasks_task_id_progress POST /v2/tasks/task_id/progress Post Progress into Task
CropwisePlatformSdk::TaskApi update_v2_tasks PUT /v2/tasks/task_id Task Update
CropwisePlatformSdk::TaskApi update_v2_tasks_comment PUT /v2/tasks/comments/comment_id Comment Update
CropwisePlatformSdk::TaskApi v2_orgs_org_id_tasks_get GET /v2/orgs/org_id/tasks Get task by organization
CropwisePlatformSdk::TermsApi delete_terms_terms_id DELETE /v2/terms/termsId Delete Terms
CropwisePlatformSdk::TermsApi get_terms GET /v2/terms List User Terms
CropwisePlatformSdk::TermsApi get_terms_terms_id GET /v2/terms/termsId Get Terms By Id
CropwisePlatformSdk::TermsApi get_termsall GET /v2/terms/all List All Terms
CropwisePlatformSdk::TermsApi post_terms POST /v2/terms Create a New Term
CropwisePlatformSdk::TermsApi post_termssign POST /v2/terms/sign Sign terms and Plans
CropwisePlatformSdk::TermsApi put_terms_terms_id PUT /v2/terms/termsId Edit Terms
CropwisePlatformSdk::UtilsApi geojson_converter POST /v2/utils/geo/as-geojson Convert KML or Shapefile to GeoJSON
CropwisePlatformSdk::UtilsApi regulatory_zones POST /v2/utils/geo/regulatory-zones Get List of country codes in ISO3166Alpha2 format.
CropwisePlatformSdk::VarietyApi get_variesties GET /v2/varieties List varieties
CropwisePlatformSdk::VouchersApi delete_vouchers_voucher_id DELETE /v2/vouchers/voucherId Delete Voucher by appId
CropwisePlatformSdk::VouchersApi get_campaign_vouchers_campaign_id GET /v2/campaigns/campaignId/vouchers Get Campaign Vouchers
CropwisePlatformSdk::VouchersApi get_vouchers_voucher_id GET /v2/vouchers/voucherId Get Voucher By Id
CropwisePlatformSdk::VouchersApi get_vouchers_voucher_id_redeem_info GET /v2/vouchers/voucherId/redeem-info Get All Plans from a Voucher
CropwisePlatformSdk::VouchersApi post_campaign_vouchers_campaign_id POST /v2/campaigns/campaignId/vouchers Add Vouchers to Campaign
CropwisePlatformSdk::VouchersApi post_vouchers POST /v2/vouchers Create Voucher
CropwisePlatformSdk::VouchersApi put_vouchers_voucher_id PUT /v2/vouchers/voucherId Edit Voucher by ID
CropwisePlatformSdk::VouchersApi redeem_voucher POST /v2/vouchers/redeem Redeem Voucher
CropwisePlatformSdk::WorkerApi delete_worker_by_id DELETE /v2/orgs/orgId/workers/id
CropwisePlatformSdk::WorkerApi get_worker GET /v2/orgs/orgId/workers/id Get worker
CropwisePlatformSdk::WorkerApi get_workers GET /v2/orgs/org_id/workers List Organization Workers
CropwisePlatformSdk::WorkerApi get_workers_by_org_id_and_properties_ids POST /v2/orgs/org_id/properties/ids/workers List Organization Workers by Property Id and Name
CropwisePlatformSdk::WorkerApi get_workers_extended_search GET /v2/orgs/org_id/workers/extended-search List Organization Workers with filtered extra_attribute
CropwisePlatformSdk::WorkerApi post_worker POST /v2/orgs/orgId/workers Create worker
CropwisePlatformSdk::WorkerApi update_worker PUT /v2/orgs/orgId/workers/id Update worker
CropwisePlatformSdk::WorkspacesApi delete_entities_from_account_workspace_id DELETE /v2/workspaces/workspaceId/entities Delete entities in a workspace's contracts
CropwisePlatformSdk::WorkspacesApi delete_workspace_workspace_id DELETE /v2/workspaces/workspaceId Delete workspace
CropwisePlatformSdk::WorkspacesApi get_accounts_by_defualt_workspace_id POST /v2/workspaces/ids/accounts Get Accounts from its default workspaces ids
CropwisePlatformSdk::WorkspacesApi get_contracts_by_entitlement GET /v2/workspaces/contracts/by-entitlements Get contracts by entitlements
CropwisePlatformSdk::WorkspacesApi get_root_owners_workspace_id POST /v2/workspaces/ids/root-owners Get Root owners from the orgs that the workspace id is linked
CropwisePlatformSdk::WorkspacesApi get_workspace_by_app_workspace_id GET /v2/apps/appId/workspaces/simple Get WorkspaceIds from a App
CropwisePlatformSdk::WorkspacesApi get_workspace_workspace_id GET /v2/workspaces/workspaceId Get workspace by Id
CropwisePlatformSdk::WorkspacesApi get_workspaces GET /v2/workspaces Get Workspaces
CropwisePlatformSdk::WorkspacesApi post_workspace POST /v2/workspaces Create a new workspace
CropwisePlatformSdk::WorkspacesApi put_workspace_workspace_id PUT /v2/workspaces/workspaceId Edit workspace

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

OAuth2

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
    • read: Read all resources
    • write: Write all resources

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: /oauth/authorize
  • Scopes:
    • read: Read all resources
    • write: Write all resources