Query Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| minAvgMaterial | Double | No | Minimum average amount of material applied during the application (inclusive). |
| maxAvgMaterial | Double | No | Maximum average amount of material applied during the application (inclusive). |
| minTotalMaterial | Double | No | Minimum total amount of material applied during the application (inclusive). |
| maxTotalMaterial | Double | No | Maximum total amount of material applied during the application (inclusive). |
| sources | List<String> | No | Sources of the operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| associatedBoundaryIds | List<String> | No | Boundary IDs associated with operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minOperationStartDateTime | OffsetDateTime | No | Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationStartDateTime | OffsetDateTime | No | Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationEndDateTime | OffsetDateTime | No | Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationEndDateTime | OffsetDateTime | No | Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationModifiedDateTime | OffsetDateTime | No | Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationModifiedDateTime | OffsetDateTime | No | Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minArea | Double | No | Minimum area for which operation was applied (inclusive). |
| maxArea | Double | No | Maximum area for which operation was applied (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * applicationProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * isCarrier: Boolean (Optional)
- * avgMaterial (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * }
- * ]
- * avgMaterial (Optional): (recursive schema, see avgMaterial above)
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job Id supplied by end user.
- * @param partyId Id of the party.
- * @param applicationDataId Id of the application data.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link PollerFlux} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public PollerFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return cascade delete job for application data resource along with {@link Response} on successful completion of
- * {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| minAvgMaterial | Double | No | Minimum average amount of material applied during the application (inclusive). |
| maxAvgMaterial | Double | No | Maximum average amount of material applied during the application (inclusive). |
| minTotalMaterial | Double | No | Minimum total amount of material applied during the application (inclusive). |
| maxTotalMaterial | Double | No | Maximum total amount of material applied during the application (inclusive). |
| sources | List<String> | No | Sources of the operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| associatedBoundaryIds | List<String> | No | Boundary IDs associated with operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minOperationStartDateTime | OffsetDateTime | No | Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationStartDateTime | OffsetDateTime | No | Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationEndDateTime | OffsetDateTime | No | Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationEndDateTime | OffsetDateTime | No | Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationModifiedDateTime | OffsetDateTime | No | Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationModifiedDateTime | OffsetDateTime | No | Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minArea | Double | No | Minimum area for which operation was applied (inclusive). |
| maxArea | Double | No | Maximum area for which operation was applied (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * applicationProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * isCarrier: Boolean (Optional)
- * avgMaterial (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * }
- * ]
- * avgMaterial (Optional): (recursive schema, see avgMaterial above)
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * applicationProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * isCarrier: Boolean (Optional)
- * avgMaterial (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * }
- * ]
- * avgMaterial (Optional): (recursive schema, see avgMaterial above)
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party resource.
- * @param applicationDataId ID of the application data resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified application data resource under a particular party along with {@link Response} on successful
- * completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoRequest Body Schema - * - *
{@code
- * {
- * applicationProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * isCarrier: Boolean (Optional)
- * avgMaterial (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * }
- * ]
- * avgMaterial (Optional): (recursive schema, see avgMaterial above)
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * applicationProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * isCarrier: Boolean (Optional)
- * avgMaterial (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * }
- * ]
- * avgMaterial (Optional): (recursive schema, see avgMaterial above)
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party.
- * @param applicationDataId ID of the application data resource.
- * @param applicationData Application data resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of application data resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| minAvgMaterial | Double | No | Minimum average amount of material applied during the application (inclusive). |
| maxAvgMaterial | Double | No | Maximum average amount of material applied during the application (inclusive). |
| minTotalMaterial | Double | No | Minimum total amount of material applied during the application (inclusive). |
| maxTotalMaterial | Double | No | Maximum total amount of material applied during the application (inclusive). |
| sources | List<String> | No | Sources of the operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| associatedBoundaryIds | List<String> | No | Boundary IDs associated with operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minOperationStartDateTime | OffsetDateTime | No | Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationStartDateTime | OffsetDateTime | No | Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationEndDateTime | OffsetDateTime | No | Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationEndDateTime | OffsetDateTime | No | Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationModifiedDateTime | OffsetDateTime | No | Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationModifiedDateTime | OffsetDateTime | No | Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minArea | Double | No | Minimum area for which operation was applied (inclusive). |
| maxArea | Double | No | Maximum area for which operation was applied (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * applicationProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * isCarrier: Boolean (Optional)
- * avgMaterial (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * }
- * ]
- * avgMaterial (Optional): (recursive schema, see avgMaterial above)
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job Id supplied by end user.
- * @param partyId Id of the party.
- * @param applicationDataId Id of the application data.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link SyncPoller} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public SyncPollerResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return cascade delete job for application data resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| minAvgMaterial | Double | No | Minimum average amount of material applied during the application (inclusive). |
| maxAvgMaterial | Double | No | Maximum average amount of material applied during the application (inclusive). |
| minTotalMaterial | Double | No | Minimum total amount of material applied during the application (inclusive). |
| maxTotalMaterial | Double | No | Maximum total amount of material applied during the application (inclusive). |
| sources | List<String> | No | Sources of the operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| associatedBoundaryIds | List<String> | No | Boundary IDs associated with operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minOperationStartDateTime | OffsetDateTime | No | Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationStartDateTime | OffsetDateTime | No | Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationEndDateTime | OffsetDateTime | No | Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationEndDateTime | OffsetDateTime | No | Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationModifiedDateTime | OffsetDateTime | No | Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationModifiedDateTime | OffsetDateTime | No | Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minArea | Double | No | Minimum area for which operation was applied (inclusive). |
| maxArea | Double | No | Maximum area for which operation was applied (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * applicationProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * isCarrier: Boolean (Optional)
- * avgMaterial (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * }
- * ]
- * avgMaterial (Optional): (recursive schema, see avgMaterial above)
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * applicationProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * isCarrier: Boolean (Optional)
- * avgMaterial (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * }
- * ]
- * avgMaterial (Optional): (recursive schema, see avgMaterial above)
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party resource.
- * @param applicationDataId ID of the application data resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified application data resource under a particular party along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseRequest Body Schema - * - *
{@code
- * {
- * applicationProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * isCarrier: Boolean (Optional)
- * avgMaterial (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * }
- * ]
- * avgMaterial (Optional): (recursive schema, see avgMaterial above)
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * applicationProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * isCarrier: Boolean (Optional)
- * avgMaterial (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * }
- * ]
- * avgMaterial (Optional): (recursive schema, see avgMaterial above)
- * totalMaterial (Optional): (recursive schema, see totalMaterial above)
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party.
- * @param applicationDataId ID of the application data resource.
- * @param applicationData Application data resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of application data resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| resourceIds | List<String> | No | Resource Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| resourceTypes | List<String> | No | Resource Types of the resource. - * i.e. Party, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * resourceId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary/ApplicationData/HarvestData/TillageData/PlantingData/PlantTissueAnalysis) (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * resourceId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary/ApplicationData/HarvestData/TillageData/PlantingData/PlantTissueAnalysis) (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param attachmentId Id of the attachment.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified attachment resource under a particular party along with {@link Response} on successful
- * completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoHeader Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Type | String | No | The content type. Allowed values: "multipart/form-data". |
Request Body Schema - * - *
{@code
- * BinaryData
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * resourceId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary/ApplicationData/HarvestData/TillageData/PlantingData/PlantTissueAnalysis) (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party resource.
- * @param attachmentId Id of the attachment resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of attachment resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * BinaryData
- * }
- *
- * @param partyId Id of the associated party.
- * @param attachmentId Id of attachment to be downloaded.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the response body along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| resourceIds | List<String> | No | Resource Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| resourceTypes | List<String> | No | Resource Types of the resource. - * i.e. Party, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * resourceId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary/ApplicationData/HarvestData/TillageData/PlantingData/PlantTissueAnalysis) (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * resourceId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary/ApplicationData/HarvestData/TillageData/PlantingData/PlantTissueAnalysis) (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param attachmentId Id of the attachment.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified attachment resource under a particular party along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseHeader Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Type | String | No | The content type. Allowed values: "multipart/form-data". |
Request Body Schema - * - *
{@code
- * BinaryData
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * resourceId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary/ApplicationData/HarvestData/TillageData/PlantingData/PlantTissueAnalysis) (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party resource.
- * @param attachmentId Id of the attachment resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of attachment resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseResponse Body Schema - * - *
{@code
- * BinaryData
- * }
- *
- * @param partyId Id of the associated party.
- * @param attachmentId Id of attachment to be downloaded.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the response body along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| parentType | String | No | Type of the parent it belongs to. |
| type | String | No | Type it belongs to. |
| parentIds | List<String> | No | Parent Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minArea | Double | No | Minimum area of the boundary (inclusive). |
| maxArea | Double | No | Maximum acreage of the boundary (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxRequest Body Schema - * - *
{@code
- * {
- * ids (Optional): [
- * String (Optional)
- * ]
- * names (Optional): [
- * String (Optional)
- * ]
- * propertyFilters (Optional): [
- * String (Optional)
- * ]
- * statuses (Optional): [
- * String (Optional)
- * ]
- * minCreatedDateTime: OffsetDateTime (Optional)
- * maxCreatedDateTime: OffsetDateTime (Optional)
- * minLastModifiedDateTime: OffsetDateTime (Optional)
- * maxLastModifiedDateTime: OffsetDateTime (Optional)
- * maxPageSize: Integer (Optional)
- * skipToken: String (Optional)
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * parentIds (Optional): [
- * String (Optional)
- * ]
- * minArea: Double (Optional)
- * maxArea: Double (Optional)
- * intersectsWithGeometry (Optional): {
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param searchBoundaryQuery Query filters.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job ID supplied by end user.
- * @param partyId ID of the associated party.
- * @param boundaryId ID of the boundary to be deleted.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link PollerFlux} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public PollerFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return cascade delete job for specified boundary along with {@link Response} on successful completion of {@link
- * Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| parentType | String | No | Type of the parent it belongs to. |
| type | String | No | Type it belongs to. |
| parentIds | List<String> | No | Parent Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minArea | Double | No | Minimum area of the boundary (inclusive). |
| maxArea | Double | No | Maximum acreage of the boundary (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxRequest Body Schema - * - *
{@code
- * {
- * ids (Optional): [
- * String (Optional)
- * ]
- * names (Optional): [
- * String (Optional)
- * ]
- * propertyFilters (Optional): [
- * String (Optional)
- * ]
- * statuses (Optional): [
- * String (Optional)
- * ]
- * minCreatedDateTime: OffsetDateTime (Optional)
- * maxCreatedDateTime: OffsetDateTime (Optional)
- * minLastModifiedDateTime: OffsetDateTime (Optional)
- * maxLastModifiedDateTime: OffsetDateTime (Optional)
- * maxPageSize: Integer (Optional)
- * skipToken: String (Optional)
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * parentIds (Optional): [
- * String (Optional)
- * ]
- * minArea: Double (Optional)
- * maxArea: Double (Optional)
- * intersectsWithGeometry (Optional): {
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the party.
- * @param searchBoundaryQuery Query filters.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxRequest Body Schema - * - *
{@code
- * {
- * geometry (Optional): {
- * }
- * type: String (Optional)
- * crs: String (Optional)
- * centroid (Optional): (recursive schema, see centroid above)
- * bbox (Optional): (recursive schema, see bbox above)
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * geometry (Optional): {
- * }
- * type: String (Optional)
- * crs: String (Optional)
- * centroid (Optional): (recursive schema, see centroid above)
- * bbox (Optional): (recursive schema, see bbox above)
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the party resource.
- * @param boundaryId Id of the boundary resource.
- * @param boundary Boundary resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of boundary resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * {
- * geometry (Optional): {
- * }
- * type: String (Optional)
- * crs: String (Optional)
- * centroid (Optional): (recursive schema, see centroid above)
- * bbox (Optional): (recursive schema, see bbox above)
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param boundaryId Id of the boundary.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified boundary resource under a particular party along with {@link Response} on successful
- * completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * {
- * boundaryArea: Double (Optional)
- * otherBoundaryArea: Double (Optional)
- * intersectingArea: Double (Optional)
- * }
- * }
- *
- * @param partyId Id of the party.
- * @param boundaryId Id of the boundary.
- * @param otherPartyId PartyId of the other field.
- * @param otherBoundaryId Id of the other boundary.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of boundary overlap response along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| parentType | String | No | Type of the parent it belongs to. |
| type | String | No | Type it belongs to. |
| parentIds | List<String> | No | Parent Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minArea | Double | No | Minimum area of the boundary (inclusive). |
| maxArea | Double | No | Maximum acreage of the boundary (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableRequest Body Schema - * - *
{@code
- * {
- * ids (Optional): [
- * String (Optional)
- * ]
- * names (Optional): [
- * String (Optional)
- * ]
- * propertyFilters (Optional): [
- * String (Optional)
- * ]
- * statuses (Optional): [
- * String (Optional)
- * ]
- * minCreatedDateTime: OffsetDateTime (Optional)
- * maxCreatedDateTime: OffsetDateTime (Optional)
- * minLastModifiedDateTime: OffsetDateTime (Optional)
- * maxLastModifiedDateTime: OffsetDateTime (Optional)
- * maxPageSize: Integer (Optional)
- * skipToken: String (Optional)
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * parentIds (Optional): [
- * String (Optional)
- * ]
- * minArea: Double (Optional)
- * maxArea: Double (Optional)
- * intersectsWithGeometry (Optional): {
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param searchBoundaryQuery Query filters.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job ID supplied by end user.
- * @param partyId ID of the associated party.
- * @param boundaryId ID of the boundary to be deleted.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link SyncPoller} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public SyncPollerResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return cascade delete job for specified boundary along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| parentType | String | No | Type of the parent it belongs to. |
| type | String | No | Type it belongs to. |
| parentIds | List<String> | No | Parent Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minArea | Double | No | Minimum area of the boundary (inclusive). |
| maxArea | Double | No | Maximum acreage of the boundary (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableRequest Body Schema - * - *
{@code
- * {
- * ids (Optional): [
- * String (Optional)
- * ]
- * names (Optional): [
- * String (Optional)
- * ]
- * propertyFilters (Optional): [
- * String (Optional)
- * ]
- * statuses (Optional): [
- * String (Optional)
- * ]
- * minCreatedDateTime: OffsetDateTime (Optional)
- * maxCreatedDateTime: OffsetDateTime (Optional)
- * minLastModifiedDateTime: OffsetDateTime (Optional)
- * maxLastModifiedDateTime: OffsetDateTime (Optional)
- * maxPageSize: Integer (Optional)
- * skipToken: String (Optional)
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * parentIds (Optional): [
- * String (Optional)
- * ]
- * minArea: Double (Optional)
- * maxArea: Double (Optional)
- * intersectsWithGeometry (Optional): {
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * type: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the party.
- * @param searchBoundaryQuery Query filters.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableRequest Body Schema - * - *
{@code
- * {
- * geometry (Optional): {
- * }
- * type: String (Optional)
- * crs: String (Optional)
- * centroid (Optional): (recursive schema, see centroid above)
- * bbox (Optional): (recursive schema, see bbox above)
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * geometry (Optional): {
- * }
- * type: String (Optional)
- * crs: String (Optional)
- * centroid (Optional): (recursive schema, see centroid above)
- * bbox (Optional): (recursive schema, see bbox above)
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the party resource.
- * @param boundaryId Id of the boundary resource.
- * @param boundary Boundary resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of boundary resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseResponse Body Schema - * - *
{@code
- * {
- * geometry (Optional): {
- * }
- * type: String (Optional)
- * crs: String (Optional)
- * centroid (Optional): (recursive schema, see centroid above)
- * bbox (Optional): (recursive schema, see bbox above)
- * partyId: String (Optional)
- * parentId: String (Optional)
- * area (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param boundaryId Id of the boundary.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified boundary resource under a particular party along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseResponse Body Schema - * - *
{@code
- * {
- * boundaryArea: Double (Optional)
- * otherBoundaryArea: Double (Optional)
- * intersectingArea: Double (Optional)
- * }
- * }
- *
- * @param partyId Id of the party.
- * @param boundaryId Id of the boundary.
- * @param otherPartyId PartyId of the other field.
- * @param otherBoundaryId Id of the other boundary.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of boundary overlap response along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| cropIds | List<String> | No | CropIds of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| brands | List<String> | No | Brands of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| products | List<String> | No | Products of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| traits | List<String> | No | Traits of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * cropIds (Optional): [
- * String (Optional)
- * ]
- * brand: String (Optional)
- * product: String (Optional)
- * trait: String (Optional)
- * relativeMaturity (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * treatments (Optional): [
- * String (Optional)
- * ]
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * cropIds (Optional): [
- * String (Optional)
- * ]
- * brand: String (Optional)
- * product: String (Optional)
- * trait: String (Optional)
- * relativeMaturity (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * treatments (Optional): [
- * String (Optional)
- * ]
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param cropProductId Id of the crop Product.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified crop Product resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoRequest Body Schema - * - *
{@code
- * {
- * cropIds (Optional): [
- * String (Optional)
- * ]
- * brand: String (Optional)
- * product: String (Optional)
- * trait: String (Optional)
- * relativeMaturity (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * treatments (Optional): [
- * String (Optional)
- * ]
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * cropIds (Optional): [
- * String (Optional)
- * ]
- * brand: String (Optional)
- * product: String (Optional)
- * trait: String (Optional)
- * relativeMaturity (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * treatments (Optional): [
- * String (Optional)
- * ]
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param cropProductId Id of the crop Product resource.
- * @param cropProduct Crop Product resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of crop product resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| cropIds | List<String> | No | CropIds of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| brands | List<String> | No | Brands of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| products | List<String> | No | Products of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| traits | List<String> | No | Traits of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * cropIds (Optional): [
- * String (Optional)
- * ]
- * brand: String (Optional)
- * product: String (Optional)
- * trait: String (Optional)
- * relativeMaturity (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * treatments (Optional): [
- * String (Optional)
- * ]
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * cropIds (Optional): [
- * String (Optional)
- * ]
- * brand: String (Optional)
- * product: String (Optional)
- * trait: String (Optional)
- * relativeMaturity (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * treatments (Optional): [
- * String (Optional)
- * ]
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param cropProductId Id of the crop Product.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified crop Product resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseRequest Body Schema - * - *
{@code
- * {
- * cropIds (Optional): [
- * String (Optional)
- * ]
- * brand: String (Optional)
- * product: String (Optional)
- * trait: String (Optional)
- * relativeMaturity (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * treatments (Optional): [
- * String (Optional)
- * ]
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * cropIds (Optional): [
- * String (Optional)
- * ]
- * brand: String (Optional)
- * product: String (Optional)
- * trait: String (Optional)
- * relativeMaturity (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * treatments (Optional): [
- * String (Optional)
- * ]
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param cropProductId Id of the crop Product resource.
- * @param cropProduct Crop Product resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of crop product resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| phenotypes | List<String> | No | Crop phenotypes of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| breedingMethods | List<String> | No | Breeding method of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * phenotype: String (Optional)
- * breedingMethod: String(VARIETY/HYBRID/UNKNOWN) (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * phenotype: String (Optional)
- * breedingMethod: String(VARIETY/HYBRID/UNKNOWN) (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param cropId Id of the crop.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified crop resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoRequest Body Schema - * - *
{@code
- * {
- * phenotype: String (Optional)
- * breedingMethod: String(VARIETY/HYBRID/UNKNOWN) (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * phenotype: String (Optional)
- * breedingMethod: String(VARIETY/HYBRID/UNKNOWN) (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param cropId Id of the crop resource.
- * @param crop Crop resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of crop resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| phenotypes | List<String> | No | Crop phenotypes of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| breedingMethods | List<String> | No | Breeding method of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * phenotype: String (Optional)
- * breedingMethod: String(VARIETY/HYBRID/UNKNOWN) (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * phenotype: String (Optional)
- * breedingMethod: String(VARIETY/HYBRID/UNKNOWN) (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param cropId Id of the crop.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified crop resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseRequest Body Schema - * - *
{@code
- * {
- * phenotype: String (Optional)
- * breedingMethod: String(VARIETY/HYBRID/UNKNOWN) (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * phenotype: String (Optional)
- * breedingMethod: String(VARIETY/HYBRID/UNKNOWN) (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param cropId Id of the crop resource.
- * @param crop Crop resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of crop resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * type: String (Optional)
- * manufacturer: String (Optional)
- * productCode: String (Optional)
- * ports (Optional): [
- * (Optional){
- * name: String (Optional)
- * type: String (Optional)
- * }
- * ]
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the associated sensor partner.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxRequest Body Schema - * - *
{@code
- * {
- * type: String (Optional)
- * manufacturer: String (Optional)
- * productCode: String (Optional)
- * ports (Optional): [
- * (Optional){
- * name: String (Optional)
- * type: String (Optional)
- * }
- * ]
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * type: String (Optional)
- * manufacturer: String (Optional)
- * productCode: String (Optional)
- * ports (Optional): [
- * (Optional){
- * name: String (Optional)
- * type: String (Optional)
- * }
- * ]
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the sensor partner.
- * @param deviceDataModelId Id of the device data model.
- * @param deviceDataModelObject Device data model object details.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return deviceDataModel API model along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * {
- * type: String (Optional)
- * manufacturer: String (Optional)
- * productCode: String (Optional)
- * ports (Optional): [
- * (Optional){
- * name: String (Optional)
- * type: String (Optional)
- * }
- * ]
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the sensor partner.
- * @param deviceDataModelId Id of the device data model resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a device data model entity along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * type: String (Optional)
- * manufacturer: String (Optional)
- * productCode: String (Optional)
- * ports (Optional): [
- * (Optional){
- * name: String (Optional)
- * type: String (Optional)
- * }
- * ]
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the associated sensor partner.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableRequest Body Schema - * - *
{@code
- * {
- * type: String (Optional)
- * manufacturer: String (Optional)
- * productCode: String (Optional)
- * ports (Optional): [
- * (Optional){
- * name: String (Optional)
- * type: String (Optional)
- * }
- * ]
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * type: String (Optional)
- * manufacturer: String (Optional)
- * productCode: String (Optional)
- * ports (Optional): [
- * (Optional){
- * name: String (Optional)
- * type: String (Optional)
- * }
- * ]
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the sensor partner.
- * @param deviceDataModelId Id of the device data model.
- * @param deviceDataModelObject Device data model object details.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return deviceDataModel API model along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseResponse Body Schema - * - *
{@code
- * {
- * type: String (Optional)
- * manufacturer: String (Optional)
- * productCode: String (Optional)
- * ports (Optional): [
- * (Optional){
- * name: String (Optional)
- * type: String (Optional)
- * }
- * ]
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the sensor partner.
- * @param deviceDataModelId Id of the device data model resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a device data model entity along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| parentDeviceIds | List<String> | No | Id's of the parent devices. Call {@link RequestOptions#addQueryParam} to add string to array. |
| deviceDataModelIds | List<String> | No | Id's of the device data models. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * deviceDataModelId: String (Optional)
- * integrationId: String (Optional)
- * type: String (Optional)
- * hardwareId: String (Optional)
- * reportingIntervalInSeconds: Integer (Optional)
- * parentDeviceId: String (Optional)
- * location (Optional): {
- * latitude: double (Required)
- * longitude: double (Required)
- * }
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the associated sensor partner.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxRequest Body Schema - * - *
{@code
- * {
- * deviceDataModelId: String (Optional)
- * integrationId: String (Optional)
- * type: String (Optional)
- * hardwareId: String (Optional)
- * reportingIntervalInSeconds: Integer (Optional)
- * parentDeviceId: String (Optional)
- * location (Optional): {
- * latitude: double (Required)
- * longitude: double (Required)
- * }
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * deviceDataModelId: String (Optional)
- * integrationId: String (Optional)
- * type: String (Optional)
- * hardwareId: String (Optional)
- * reportingIntervalInSeconds: Integer (Optional)
- * parentDeviceId: String (Optional)
- * location (Optional): {
- * latitude: double (Required)
- * longitude: double (Required)
- * }
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the sensor partner.
- * @param deviceId Id of the device resource.
- * @param deviceDetails Device object details.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return device API model along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * {
- * deviceDataModelId: String (Optional)
- * integrationId: String (Optional)
- * type: String (Optional)
- * hardwareId: String (Optional)
- * reportingIntervalInSeconds: Integer (Optional)
- * parentDeviceId: String (Optional)
- * location (Optional): {
- * latitude: double (Required)
- * longitude: double (Required)
- * }
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the sensor partner.
- * @param deviceId Id of the device resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a device entity along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| parentDeviceIds | List<String> | No | Id's of the parent devices. Call {@link RequestOptions#addQueryParam} to add string to array. |
| deviceDataModelIds | List<String> | No | Id's of the device data models. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * deviceDataModelId: String (Optional)
- * integrationId: String (Optional)
- * type: String (Optional)
- * hardwareId: String (Optional)
- * reportingIntervalInSeconds: Integer (Optional)
- * parentDeviceId: String (Optional)
- * location (Optional): {
- * latitude: double (Required)
- * longitude: double (Required)
- * }
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the associated sensor partner.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableRequest Body Schema - * - *
{@code
- * {
- * deviceDataModelId: String (Optional)
- * integrationId: String (Optional)
- * type: String (Optional)
- * hardwareId: String (Optional)
- * reportingIntervalInSeconds: Integer (Optional)
- * parentDeviceId: String (Optional)
- * location (Optional): {
- * latitude: double (Required)
- * longitude: double (Required)
- * }
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * deviceDataModelId: String (Optional)
- * integrationId: String (Optional)
- * type: String (Optional)
- * hardwareId: String (Optional)
- * reportingIntervalInSeconds: Integer (Optional)
- * parentDeviceId: String (Optional)
- * location (Optional): {
- * latitude: double (Required)
- * longitude: double (Required)
- * }
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the sensor partner.
- * @param deviceId Id of the device resource.
- * @param deviceDetails Device object details.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return device API model along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseResponse Body Schema - * - *
{@code
- * {
- * deviceDataModelId: String (Optional)
- * integrationId: String (Optional)
- * type: String (Optional)
- * hardwareId: String (Optional)
- * reportingIntervalInSeconds: Integer (Optional)
- * parentDeviceId: String (Optional)
- * location (Optional): {
- * latitude: double (Required)
- * longitude: double (Required)
- * }
- * sensorPartnerId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param sensorPartnerId Id of the sensor partner.
- * @param deviceId Id of the device resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a device entity along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseRequest Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * authProviderId: String (Required)
- * operations (Optional): [
- * String (Optional)
- * ]
- * startYear: int (Required)
- * isIncremental: Boolean (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * authProviderId: String (Required)
- * operations (Optional): [
- * String (Optional)
- * ]
- * startYear: int (Required)
- * isIncremental: Boolean (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param jobId Job Id supplied by user.
- * @param job Job parameters supplied by user.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link PollerFlux} for polling of schema of farm operation data ingestion job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public PollerFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * authProviderId: String (Required)
- * operations (Optional): [
- * String (Optional)
- * ]
- * startYear: int (Required)
- * isIncremental: Boolean (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a farm operation data ingestion job along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoRequest Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * authProviderId: String (Required)
- * operations (Optional): [
- * String (Optional)
- * ]
- * startYear: int (Required)
- * isIncremental: Boolean (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * authProviderId: String (Required)
- * operations (Optional): [
- * String (Optional)
- * ]
- * startYear: int (Required)
- * isIncremental: Boolean (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param jobId Job Id supplied by user.
- * @param job Job parameters supplied by user.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link SyncPoller} for polling of schema of farm operation data ingestion job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public SyncPollerResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * authProviderId: String (Required)
- * operations (Optional): [
- * String (Optional)
- * ]
- * startYear: int (Required)
- * isIncremental: Boolean (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a farm operation data ingestion job along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job ID supplied by end user.
- * @param partyId ID of the associated party.
- * @param farmId ID of the farm to be deleted.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link PollerFlux} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public PollerFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a cascade delete job for specified farm along with {@link Response} on successful completion of {@link
- * Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party resource.
- * @param farmId ID of the farm resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified farm resource under a particular party along with {@link Response} on successful completion
- * of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoRequest Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party resource.
- * @param farmId Id of the farm resource.
- * @param farm Farm resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of farm resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job ID supplied by end user.
- * @param partyId ID of the associated party.
- * @param farmId ID of the farm to be deleted.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link SyncPoller} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public SyncPollerResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a cascade delete job for specified farm along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party resource.
- * @param farmId ID of the farm resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified farm resource under a particular party along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseRequest Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party resource.
- * @param farmId Id of the farm resource.
- * @param farm Farm resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of farm resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| farmIds | List<String> | No | Farm Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * farmId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a cascade delete job for specified field along with {@link Response} on successful completion of {@link
- * Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job ID supplied by end user.
- * @param partyId ID of the associated party.
- * @param fieldId ID of the field to be deleted.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link PollerFlux} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public PollerFluxQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| farmIds | List<String> | No | Farm Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * farmId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * farmId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param fieldId Id of the field.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified field resource under a particular party along with {@link Response} on successful completion
- * of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoRequest Body Schema - * - *
{@code
- * {
- * farmId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * farmId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party resource.
- * @param fieldId Id of the field resource.
- * @param field Field resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of field resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| farmIds | List<String> | No | Farm Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * farmId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a cascade delete job for specified field along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job ID supplied by end user.
- * @param partyId ID of the associated party.
- * @param fieldId ID of the field to be deleted.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link SyncPoller} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public SyncPollerQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| farmIds | List<String> | No | Farm Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * farmId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * farmId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param fieldId Id of the field.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified field resource under a particular party along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseRequest Body Schema - * - *
{@code
- * {
- * farmId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * farmId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party resource.
- * @param fieldId Id of the field resource.
- * @param field Field resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of field resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| minTotalYield | Double | No | Minimum Yield value(inclusive). |
| maxTotalYield | Double | No | Maximum Yield value (inclusive). |
| minAvgYield | Double | No | Minimum AvgYield value(inclusive). |
| maxAvgYield | Double | No | Maximum AvgYield value (inclusive). |
| minTotalWetMass | Double | No | Minimum Total WetMass value(inclusive). |
| maxTotalWetMass | Double | No | Maximum Total WetMass value (inclusive). |
| minAvgWetMass | Double | No | Minimum AvgWetMass value(inclusive). |
| maxAvgWetMass | Double | No | Maximum AvgWetMass value (inclusive). |
| minAvgMoisture | Double | No | Minimum AvgMoisture value(inclusive). |
| maxAvgMoisture | Double | No | Maximum AvgMoisture value (inclusive). |
| minAvgSpeed | Double | No | Minimum AvgSpeed value(inclusive). |
| maxAvgSpeed | Double | No | Maximum AvgSpeed value (inclusive). |
| sources | List<String> | No | Sources of the operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| associatedBoundaryIds | List<String> | No | Boundary IDs associated with operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minOperationStartDateTime | OffsetDateTime | No | Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationStartDateTime | OffsetDateTime | No | Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationEndDateTime | OffsetDateTime | No | Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationEndDateTime | OffsetDateTime | No | Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationModifiedDateTime | OffsetDateTime | No | Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationModifiedDateTime | OffsetDateTime | No | Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minArea | Double | No | Minimum area for which operation was applied (inclusive). |
| maxArea | Double | No | Maximum area for which operation was applied (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * totalYield (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * avgYield (Optional): (recursive schema, see avgYield above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * avgSpeed (Optional): (recursive schema, see avgSpeed above)
- * harvestProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * area (Optional): (recursive schema, see area above)
- * totalYield (Optional): (recursive schema, see totalYield above)
- * avgYield (Optional): (recursive schema, see avgYield above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * }
- * ]
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job Id supplied by end user.
- * @param partyId Id of the party.
- * @param harvestDataId Id of the harvest data.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link PollerFlux} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public PollerFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return cascade delete job for harvest data resource along with {@link Response} on successful completion of
- * {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| minTotalYield | Double | No | Minimum Yield value(inclusive). |
| maxTotalYield | Double | No | Maximum Yield value (inclusive). |
| minAvgYield | Double | No | Minimum AvgYield value(inclusive). |
| maxAvgYield | Double | No | Maximum AvgYield value (inclusive). |
| minTotalWetMass | Double | No | Minimum Total WetMass value(inclusive). |
| maxTotalWetMass | Double | No | Maximum Total WetMass value (inclusive). |
| minAvgWetMass | Double | No | Minimum AvgWetMass value(inclusive). |
| maxAvgWetMass | Double | No | Maximum AvgWetMass value (inclusive). |
| minAvgMoisture | Double | No | Minimum AvgMoisture value(inclusive). |
| maxAvgMoisture | Double | No | Maximum AvgMoisture value (inclusive). |
| minAvgSpeed | Double | No | Minimum AvgSpeed value(inclusive). |
| maxAvgSpeed | Double | No | Maximum AvgSpeed value (inclusive). |
| sources | List<String> | No | Sources of the operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| associatedBoundaryIds | List<String> | No | Boundary IDs associated with operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minOperationStartDateTime | OffsetDateTime | No | Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationStartDateTime | OffsetDateTime | No | Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationEndDateTime | OffsetDateTime | No | Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationEndDateTime | OffsetDateTime | No | Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationModifiedDateTime | OffsetDateTime | No | Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationModifiedDateTime | OffsetDateTime | No | Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minArea | Double | No | Minimum area for which operation was applied (inclusive). |
| maxArea | Double | No | Maximum area for which operation was applied (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * totalYield (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * avgYield (Optional): (recursive schema, see avgYield above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * avgSpeed (Optional): (recursive schema, see avgSpeed above)
- * harvestProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * area (Optional): (recursive schema, see area above)
- * totalYield (Optional): (recursive schema, see totalYield above)
- * avgYield (Optional): (recursive schema, see avgYield above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * }
- * ]
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * totalYield (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * avgYield (Optional): (recursive schema, see avgYield above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * avgSpeed (Optional): (recursive schema, see avgSpeed above)
- * harvestProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * area (Optional): (recursive schema, see area above)
- * totalYield (Optional): (recursive schema, see totalYield above)
- * avgYield (Optional): (recursive schema, see avgYield above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * }
- * ]
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party resource.
- * @param harvestDataId ID of the harvest data resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified harvest data resource under a particular party along with {@link Response} on successful
- * completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoRequest Body Schema - * - *
{@code
- * {
- * totalYield (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * avgYield (Optional): (recursive schema, see avgYield above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * avgSpeed (Optional): (recursive schema, see avgSpeed above)
- * harvestProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * area (Optional): (recursive schema, see area above)
- * totalYield (Optional): (recursive schema, see totalYield above)
- * avgYield (Optional): (recursive schema, see avgYield above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * }
- * ]
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * totalYield (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * avgYield (Optional): (recursive schema, see avgYield above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * avgSpeed (Optional): (recursive schema, see avgSpeed above)
- * harvestProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * area (Optional): (recursive schema, see area above)
- * totalYield (Optional): (recursive schema, see totalYield above)
- * avgYield (Optional): (recursive schema, see avgYield above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * }
- * ]
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the party.
- * @param harvestDataId ID of the harvest data resource.
- * @param harvestData Harvest data resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of harvest data resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| minTotalYield | Double | No | Minimum Yield value(inclusive). |
| maxTotalYield | Double | No | Maximum Yield value (inclusive). |
| minAvgYield | Double | No | Minimum AvgYield value(inclusive). |
| maxAvgYield | Double | No | Maximum AvgYield value (inclusive). |
| minTotalWetMass | Double | No | Minimum Total WetMass value(inclusive). |
| maxTotalWetMass | Double | No | Maximum Total WetMass value (inclusive). |
| minAvgWetMass | Double | No | Minimum AvgWetMass value(inclusive). |
| maxAvgWetMass | Double | No | Maximum AvgWetMass value (inclusive). |
| minAvgMoisture | Double | No | Minimum AvgMoisture value(inclusive). |
| maxAvgMoisture | Double | No | Maximum AvgMoisture value (inclusive). |
| minAvgSpeed | Double | No | Minimum AvgSpeed value(inclusive). |
| maxAvgSpeed | Double | No | Maximum AvgSpeed value (inclusive). |
| sources | List<String> | No | Sources of the operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| associatedBoundaryIds | List<String> | No | Boundary IDs associated with operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minOperationStartDateTime | OffsetDateTime | No | Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationStartDateTime | OffsetDateTime | No | Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationEndDateTime | OffsetDateTime | No | Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationEndDateTime | OffsetDateTime | No | Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationModifiedDateTime | OffsetDateTime | No | Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationModifiedDateTime | OffsetDateTime | No | Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minArea | Double | No | Minimum area for which operation was applied (inclusive). |
| maxArea | Double | No | Maximum area for which operation was applied (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * totalYield (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * avgYield (Optional): (recursive schema, see avgYield above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * avgSpeed (Optional): (recursive schema, see avgSpeed above)
- * harvestProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * area (Optional): (recursive schema, see area above)
- * totalYield (Optional): (recursive schema, see totalYield above)
- * avgYield (Optional): (recursive schema, see avgYield above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * }
- * ]
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job Id supplied by end user.
- * @param partyId Id of the party.
- * @param harvestDataId Id of the harvest data.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link SyncPoller} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public SyncPollerResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return cascade delete job for harvest data resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| minTotalYield | Double | No | Minimum Yield value(inclusive). |
| maxTotalYield | Double | No | Maximum Yield value (inclusive). |
| minAvgYield | Double | No | Minimum AvgYield value(inclusive). |
| maxAvgYield | Double | No | Maximum AvgYield value (inclusive). |
| minTotalWetMass | Double | No | Minimum Total WetMass value(inclusive). |
| maxTotalWetMass | Double | No | Maximum Total WetMass value (inclusive). |
| minAvgWetMass | Double | No | Minimum AvgWetMass value(inclusive). |
| maxAvgWetMass | Double | No | Maximum AvgWetMass value (inclusive). |
| minAvgMoisture | Double | No | Minimum AvgMoisture value(inclusive). |
| maxAvgMoisture | Double | No | Maximum AvgMoisture value (inclusive). |
| minAvgSpeed | Double | No | Minimum AvgSpeed value(inclusive). |
| maxAvgSpeed | Double | No | Maximum AvgSpeed value (inclusive). |
| sources | List<String> | No | Sources of the operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| associatedBoundaryIds | List<String> | No | Boundary IDs associated with operation data. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minOperationStartDateTime | OffsetDateTime | No | Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationStartDateTime | OffsetDateTime | No | Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationEndDateTime | OffsetDateTime | No | Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationEndDateTime | OffsetDateTime | No | Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minOperationModifiedDateTime | OffsetDateTime | No | Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| maxOperationModifiedDateTime | OffsetDateTime | No | Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). |
| minArea | Double | No | Minimum area for which operation was applied (inclusive). |
| maxArea | Double | No | Maximum area for which operation was applied (inclusive). |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * totalYield (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * avgYield (Optional): (recursive schema, see avgYield above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * avgSpeed (Optional): (recursive schema, see avgSpeed above)
- * harvestProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * area (Optional): (recursive schema, see area above)
- * totalYield (Optional): (recursive schema, see totalYield above)
- * avgYield (Optional): (recursive schema, see avgYield above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * }
- * ]
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableResponse Body Schema - * - *
{@code
- * {
- * totalYield (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * avgYield (Optional): (recursive schema, see avgYield above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * avgSpeed (Optional): (recursive schema, see avgSpeed above)
- * harvestProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * area (Optional): (recursive schema, see area above)
- * totalYield (Optional): (recursive schema, see totalYield above)
- * avgYield (Optional): (recursive schema, see avgYield above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * }
- * ]
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the associated party resource.
- * @param harvestDataId ID of the harvest data resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified harvest data resource under a particular party along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseRequest Body Schema - * - *
{@code
- * {
- * totalYield (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * avgYield (Optional): (recursive schema, see avgYield above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * avgSpeed (Optional): (recursive schema, see avgSpeed above)
- * harvestProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * area (Optional): (recursive schema, see area above)
- * totalYield (Optional): (recursive schema, see totalYield above)
- * avgYield (Optional): (recursive schema, see avgYield above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * }
- * ]
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * totalYield (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * avgYield (Optional): (recursive schema, see avgYield above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * avgSpeed (Optional): (recursive schema, see avgSpeed above)
- * harvestProductDetails (Optional): [
- * (Optional){
- * productName: String (Optional)
- * area (Optional): (recursive schema, see area above)
- * totalYield (Optional): (recursive schema, see totalYield above)
- * avgYield (Optional): (recursive schema, see avgYield above)
- * avgMoisture (Optional): (recursive schema, see avgMoisture above)
- * totalWetMass (Optional): (recursive schema, see totalWetMass above)
- * avgWetMass (Optional): (recursive schema, see avgWetMass above)
- * }
- * ]
- * area (Optional): (recursive schema, see area above)
- * operationModifiedDateTime: OffsetDateTime (Optional)
- * operationStartDateTime: OffsetDateTime (Optional)
- * operationEndDateTime: OffsetDateTime (Optional)
- * attachmentsLink: String (Optional)
- * associatedBoundaryId: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId ID of the party.
- * @param harvestDataId ID of the harvest data resource.
- * @param harvestData Harvest data resource payload to create or update.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of harvest data resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseRequest Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * shapefileAttachmentId: String (Required)
- * shapefileColumnNames (Required): [
- * String (Required)
- * ]
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * shapefileAttachmentId: String (Required)
- * shapefileColumnNames (Required): [
- * String (Required)
- * ]
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param jobId JobId provided by user.
- * @param job Job parameters supplied by user.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link PollerFlux} for polling of image Processing Rasterize Job to convert shapefile into tiff file.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public PollerFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * shapefileAttachmentId: String (Required)
- * shapefileColumnNames (Required): [
- * String (Required)
- * ]
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return imageProcessing Rasterize job's details along with {@link Response} on successful completion of {@link
- * Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoRequest Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * shapefileAttachmentId: String (Required)
- * shapefileColumnNames (Required): [
- * String (Required)
- * ]
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * shapefileAttachmentId: String (Required)
- * shapefileColumnNames (Required): [
- * String (Required)
- * ]
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param jobId JobId provided by user.
- * @param job Job parameters supplied by user.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link SyncPoller} for polling of image Processing Rasterize Job to convert shapefile into tiff file.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public SyncPollerResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * shapefileAttachmentId: String (Required)
- * shapefileColumnNames (Required): [
- * String (Required)
- * ]
- * id: String (Optional)
- * status: String (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return imageProcessing Rasterize job's details along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| insightIds | List<String> | No | List of insight IDs. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * insightId: String (Required)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxHeader Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Type | String | No | The content type. Allowed values: "multipart/form-data". |
Request Body Schema - * - *
{@code
- * BinaryData
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * insightId: String (Required)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId',
- * 'SoilMoistureModelId' or any solution id.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param insightAttachmentId Id of the insight resource.
- * @param insightId InsightID for this InsightAttachment.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of insight attachment resource along with {@link Response} on successful completion of {@link
- * Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * {
- * insightId: String (Required)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId',
- * 'SoilMoistureModelId' or any solution id.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param insightAttachmentId Id of the insight attachment resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified insight resource under a particular party along with {@link Response} on successful
- * completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * BinaryData
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId',
- * 'SoilMoistureModelId' or any solution id.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param insightAttachmentId Id of the insight attachment resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the response body along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| insightIds | List<String> | No | List of insight IDs. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * insightId: String (Required)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableHeader Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Type | String | No | The content type. Allowed values: "multipart/form-data". |
Request Body Schema - * - *
{@code
- * BinaryData
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * insightId: String (Required)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId',
- * 'SoilMoistureModelId' or any solution id.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param insightAttachmentId Id of the insight resource.
- * @param insightId InsightID for this InsightAttachment.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of insight attachment resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseResponse Body Schema - * - *
{@code
- * {
- * insightId: String (Required)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * originalFileName: String (Optional)
- * partyId: String (Optional)
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * eTag: String (Optional)
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId',
- * 'SoilMoistureModelId' or any solution id.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param insightAttachmentId Id of the insight attachment resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified insight resource under a particular party along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseResponse Body Schema - * - *
{@code
- * BinaryData
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId',
- * 'SoilMoistureModelId' or any solution id.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param insightAttachmentId Id of the insight attachment resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the response body along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job ID supplied by end user.
- * @param partyId ID of the associated party.
- * @param modelId Id of the associated model.
- * @param resourceType Resource Type.
- * @param resourceId Id of the associated resource.
- * @param insightId Insight id.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link PollerFlux} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public PollerFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a cascade delete job for specified insight along with {@link Response} on successful completion of {@link
- * Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| minInsightStartDateTime | OffsetDateTime | No | Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. |
| maxInsightStartDateTime | OffsetDateTime | No | Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. |
| minInsightEndDateTime | OffsetDateTime | No | Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. |
| maxInsightEndDateTime | OffsetDateTime | No | Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. |
| measurementFilters | List<String> | No | Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object. - * eg. "measureKey.unit eq {testValue}" where testValue is string. - * eg. "measureKey.value eq {testValue}" where testValue = double. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * modelVersion: String (Optional)
- * attachmentsLink: String (Optional)
- * insightStartDateTime: OffsetDateTime (Optional)
- * insightEndDateTime: OffsetDateTime (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxRequest Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * modelVersion: String (Optional)
- * attachmentsLink: String (Optional)
- * insightStartDateTime: OffsetDateTime (Optional)
- * insightEndDateTime: OffsetDateTime (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * modelVersion: String (Optional)
- * attachmentsLink: String (Optional)
- * insightStartDateTime: OffsetDateTime (Optional)
- * insightEndDateTime: OffsetDateTime (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId',
- * 'SoilMoistureModelId' or any solution id.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param insightId Id of the insight resource.
- * @param insightData Insight data.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of insight resource along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * modelVersion: String (Optional)
- * attachmentsLink: String (Optional)
- * insightStartDateTime: OffsetDateTime (Optional)
- * insightEndDateTime: OffsetDateTime (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId',
- * 'SoilMoistureModelId' or any solution id.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param insightId Id of the insight resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified insight resource under a particular party along with {@link Response} on successful
- * completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job ID supplied by end user.
- * @param partyId ID of the associated party.
- * @param modelId Id of the associated model.
- * @param resourceType Resource Type.
- * @param resourceId Id of the associated resource.
- * @param insightId Insight id.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link SyncPoller} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public SyncPollerResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a cascade delete job for specified insight along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| minInsightStartDateTime | OffsetDateTime | No | Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. |
| maxInsightStartDateTime | OffsetDateTime | No | Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. |
| minInsightEndDateTime | OffsetDateTime | No | Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. |
| maxInsightEndDateTime | OffsetDateTime | No | Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. |
| measurementFilters | List<String> | No | Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object. - * eg. "measureKey.unit eq {testValue}" where testValue is string. - * eg. "measureKey.value eq {testValue}" where testValue = double. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * modelVersion: String (Optional)
- * attachmentsLink: String (Optional)
- * insightStartDateTime: OffsetDateTime (Optional)
- * insightEndDateTime: OffsetDateTime (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedIterable}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedIterableRequest Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * modelVersion: String (Optional)
- * attachmentsLink: String (Optional)
- * insightStartDateTime: OffsetDateTime (Optional)
- * insightEndDateTime: OffsetDateTime (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * modelVersion: String (Optional)
- * attachmentsLink: String (Optional)
- * insightStartDateTime: OffsetDateTime (Optional)
- * insightEndDateTime: OffsetDateTime (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId',
- * 'SoilMoistureModelId' or any solution id.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param insightId Id of the insight resource.
- * @param insightData Insight data.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return schema of insight resource along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * modelId: String (Optional)
- * resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
- * resourceId: String (Optional)
- * modelVersion: String (Optional)
- * attachmentsLink: String (Optional)
- * insightStartDateTime: OffsetDateTime (Optional)
- * insightEndDateTime: OffsetDateTime (Optional)
- * measurements (Optional): {
- * String (Optional): {
- * unit: String (Optional)
- * value: Double (Optional)
- * }
- * }
- * id: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * eTag: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param partyId Id of the associated party.
- * @param modelId Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId',
- * 'SoilMoistureModelId' or any solution id.
- * @param resourceType Resource type associated with the record.
- * @param resourceId Id of the associated resource.
- * @param insightId Id of the insight resource.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a specified insight resource under a particular party along with {@link Response}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public ResponseQuery Parameters - * - *
| Name | Type | Required | Description |
|---|---|---|---|
| types | List<String> | No | Types of the ManagementZone. Call {@link RequestOptions#addQueryParam} to add string to array. |
| cropIds | List<String> | No | CropIds of the ManagementZone. Call {@link RequestOptions#addQueryParam} to add string to array. |
| seasonIds | List<String> | No | SeasonIds of the ManagementZone. Call {@link RequestOptions#addQueryParam} to add string to array. |
| fieldIds | List<String> | No | FieldIds of the ManagementZone. Call {@link RequestOptions#addQueryParam} to add string to array. |
| sources | List<String> | No | Sources of the ManagementZone. Call {@link RequestOptions#addQueryParam} to add string to array. |
| ids | List<String> | No | Ids of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| names | List<String> | No | Names of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| propertyFilters | List<String> | No | Filters on key-value pairs within the Properties object. - * eg. "{testKey} eq {testValue}". Call {@link RequestOptions#addQueryParam} to add string to array. |
| statuses | List<String> | No | Statuses of the resource. Call {@link RequestOptions#addQueryParam} to add string to array. |
| minCreatedDateTime | OffsetDateTime | No | Minimum creation date of resource (inclusive). |
| maxCreatedDateTime | OffsetDateTime | No | Maximum creation date of resource (inclusive). |
| minLastModifiedDateTime | OffsetDateTime | No | Minimum last modified date of resource (inclusive). |
| maxLastModifiedDateTime | OffsetDateTime | No | Maximum last modified date of resource (inclusive). |
| maxPageSize | Integer | No | Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. |
| skipToken | String | No | Skip token for getting next set of results. |
Response Body Schema - * - *
{@code
- * {
- * partyId: String (Optional)
- * type: String (Optional)
- * seasonId: String (Optional)
- * cropId: String (Optional)
- * fieldId: String (Optional)
- * id: String (Optional)
- * eTag: String (Optional)
- * status: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * modifiedDateTime: OffsetDateTime (Optional)
- * source: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * createdBy: String (Optional)
- * modifiedBy: String (Optional)
- * properties (Optional): {
- * String: Object (Optional)
- * }
- * }
- * }
- *
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return paged response contains list of requested objects and a URL link to get the next set of results as
- * paginated response with {@link PagedFlux}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Id of the job.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return a cascade delete job for specified job id along with {@link Response} on successful completion of {@link
- * Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoResponse Body Schema - * - *
{@code
- * {
- * partyId: String (Required)
- * resourceId: String (Required)
- * resourceType: String (Required)
- * id: String (Optional)
- * status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
- * durationInSeconds: Double (Optional)
- * message: String (Optional)
- * errorCode: String (Optional)
- * createdDateTime: OffsetDateTime (Optional)
- * lastActionDateTime: OffsetDateTime (Optional)
- * startTime: OffsetDateTime (Optional)
- * endTime: OffsetDateTime (Optional)
- * }
- * }
- *
- * @param jobId Job ID supplied by end user.
- * @param partyId ID of the associated party.
- * @param managementZoneId ID of the management zone to be deleted.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the {@link PollerFlux} for polling of schema of cascade delete job.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
- public PollerFlux