POST api/reporting/csv

Request Csv for either set of negotiators or set of branches, with specified set of ReportFacets.

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Reporting.ReportCsvDataContract
NameDescriptionTypeAdditional information
Facets

Collection of Dezrez.Core.DataContracts.External.Api.Reporting.ReportFacet

None.

NegotiatorIds

Collection of integer

None.

From

date

None.

To

date

None.

BranchIds

Collection of integer

None.

IncludeDrafts

boolean

None.

RoleTypes

Collection of string

None.

Order

Dezrez.Core.DataContracts.External.Api.Reporting.ReportCsvOrder

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Facets": [
    0,
    0
  ],
  "NegotiatorIds": [
    1,
    2
  ],
  "From": "2024-02-25T16:11:49.118531Z",
  "To": "2024-02-25T16:11:49.1340836Z",
  "BranchIds": [
    1,
    2
  ],
  "IncludeDrafts": true,
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Order": 0
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

boolean

None.

ReportsProgress

boolean

None.

InitialStatusText

string

None.

JobReference

globally unique identifier

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "b2b46414-8020-4b0c-ad00-def826d47915",
  "Success": true
}