POST api/reporting/csv

Request Csv for either set of negotiators or set of branches, with specified set of ReportFacets. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The report csv data contract supplied with the request.

ReportCsvDataContract

Name	Description	Type	Additional information
Facets	The collection of facets.	Collection of ReportFacet	None.
NegotiatorIds	The unique identifiers of the related negotiator resources.	Collection of integer	None.
From	The from, expressed as a date and time.	date	None.
To	The to, expressed as a date and time.	date	None.
BranchIds	The unique identifiers of the related branch resources.	Collection of integer	None.
IncludeDrafts	Indicates whether include drafts is true.	boolean	None.
RoleTypes	The collection of role types.	Collection of string	None.
Order	The order classification.	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": "2026-07-23T08:10:51.9738969Z",
  "To": "2026-07-23T08:10:51.9738969Z",
  "BranchIds": [
    1,
    2
  ],
  "IncludeDrafts": true,
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Order": 0
}

Response Information

Resource Description

The response returned after the operation completes.

JobInvocationDetailsDataContract

Name	Description	Type	Additional information
SupportsCancellation	Indicates whether supports cancellation is true.	boolean	None.
ReportsProgress	Indicates whether reports progress is true.	boolean	None.
InitialStatusText	The initial status text value.	string	None.
JobReference	The job reference globally unique identifier.	globally unique identifier	None.
Success	Indicates whether success is true.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "aa15a9aa-41ac-4ef1-806c-e17d759c9518",
  "Success": true
}