POST api/Reports?organizationId={organizationId}

Add a new report Will add the report to the organization if specificied

Request Information

URI Parameters

NameDescriptionTypeAdditional information
organizationId

globally unique identifier

None.

Body Parameters

ReportDetail
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

None.

CaseName

string

None.

FriendlyId

string

None.

Template

string

None.

Sections

Collection of ReportSectionDetail

None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'XCapture.DTO.ReportSectionDetail'. Path 'Sections[0].SubSections'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'XCapture.DTO.ReportSectionDetail'. Path 'Sections[0].SubSections'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[XCapture.DTO.ReportSectionDetail, XCapture.DTO, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[XCapture.DTO.ReportSectionDetail, XCapture.DTO, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ReportDetail'.

Response Information

Resource Description

ReportSimple
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "967bb08f-b82f-4345-828d-818fa1af6a1b",
  "Name": "sample string 2"
}

application/xml, text/xml

Sample:
<ReportSimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XCapture.DTO">
  <Id>967bb08f-b82f-4345-828d-818fa1af6a1b</Id>
  <Name>sample string 2</Name>
</ReportSimple>