Sign in

v7

latestSwagger 2.02026-07-13186148695.0 KB
HarvestData

Creates or updates harvest data resource under a particular party.

patch/parties/{partyId}/harvest-data/{harvestDataId}

Path parameters

partyIdstring required

ID of the party.

harvestDataIdstring required

ID of the harvest data resource.

Query parameters

api-versionstring required

The requested API version

Response

Success

operationModifiedDateTimestring date-time

Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself.

operationStartDateTimestring date-time

Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.

operationEndDateTimestring date-time

End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.

partyIdstring

Party ID which belongs to the operation data.

idstring

Unique resource ID.

eTagstring

The ETag value to implement optimistic concurrency.

statusstring

Status of the resource.

createdDateTimestring date-time

Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.

modifiedDateTimestring date-time

Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.

sourcestring

Source of the resource.

namestring

Name to identify resource.

descriptionstring

Textual description of the resource.

createdBystring

Created by user/tenant id.

modifiedBystring

Modified by user/tenant id.

propertiesobject

A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.

Example response

{
  "operationModifiedDateTime": "2021-02-10T11:10:21Z",
  "operationStartDateTime": "2020-12-31T11:10:21Z",
  "operationEndDateTime": "2021-01-31T11:10:21Z",
  "createdDateTime": "2020-12-31T11:10:21Z",
  "modifiedDateTime": "2020-12-31T11:10:21Z",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}