| GET | /api/reports/fields | Query for Coruson Report Fields |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldId | query | Guid | No | Filter by FieldId. |
| ReportId | query | Guid | No | Filter by the Id of the Report the Fields belong to. |
| Label | query | String | No | Filter by the name of the Field. |
| FieldType | query | FieldType | Yes | Filter by the type of Field.Allowable Values
|
| FieldBankFieldId | query | Guid | No | Filter by the FieldBankFieldId of the Field. |
| SectionId | query | Guid | No | Filter by the section Id. |
| SectionName | query | string | No | Filter by the name of the section. |
| OrderBy | query | ReportFieldOrder | Yes | Property to order by in Ascending order. Default is 'Name'.Allowable Values
|
| OrderByDesc | query | ReportFieldOrder | Yes | Property to order by in Descending order.Allowable Values
|
| ThenBy | query | ReportFieldOrder | Yes | Second Property to order by in Ascending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.Allowable Values
|
| ThenByDesc | query | ReportFieldOrder | Yes | Second Property to order by in Descending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | Integer | No | Number of items to skip before returning results. Minimum suitable value is 0 and is also the default value. |
| Take | form | Integer | No | Number of items to return per page. Must be a number in the range 1-100. Default value is 100. |
| OrderBy | form | Enum | No | Order By |
| OrderByDesc | form | Enum | No | Order By Descending |
| ThenBy | form | Enum | No | Then By |
| ThenByDesc | form | Enum | No | Then By Descending |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReportFields | form | List<ReportField> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalResults | form | int | No | |
| Skip | form | int | No | |
| Take | form | int | No | |
| Links | form | List<Link> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusDescription | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| RequestUrl | form | string | No | |
| Method | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldId | form | Guid | No | |
| Label | form | string | No | |
| Value | form | string | No | |
| Code | form | string | No | |
| Text | form | string | No | |
| GuidValue | form | Guid? | No | |
| FieldType | form | FieldType | No | |
| FieldBankFieldId | form | Guid | No | |
| ChildItems | form | List<ChildItems> | No | |
| SectionId | form | Guid | No | |
| SectionName | form | string | No | |
| PersistentFormSectionId | form | Guid? | No | |
| SectionTemplateId | form | Guid? | No | |
| ParentSectionId | form | Guid? | No | |
| CollectionType | form | FieldCollectionType | No | |
| CollectionId | form | Guid? | No | |
| CollectionName | form | string | No | |
| Confidental | form | bool | No | |
| ReportId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Item | form | string | No | |
| Value | form | string | No | |
| Code | form | string | No | |
| Text | form | string | No | |
| GuidValue | form | Guid? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/GetReportFields HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: text/csv
Content-Length: length
{"FieldId":"00000000-0000-0000-0000-000000000000","Skip":0,"Version":0,"ReportId":"00000000-0000-0000-0000-000000000000","Take":0,"Label":"String","FieldType":"All","FieldBankFieldId":"00000000-0000-0000-0000-000000000000","SectionId":"00000000-0000-0000-0000-000000000000","SectionName":"String","OrderBy":"Default","OrderByDesc":"Default","ThenBy":"Default","ThenByDesc":"Default"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"TotalResults":0,"StatusDescription":"String","Skip":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Take":0,"Links":[{"Name":"String","RequestUrl":"String","Method":"String"}],"ReportFields":[{"Label":"String","Value":"String","Code":"String","Text":"String","GuidValue":"00000000-0000-0000-0000-000000000000","FieldType":"All","ChildItems":[{"Item":"String","Value":"String","Code":"String","Text":"String","GuidValue":"00000000-0000-0000-0000-000000000000"}],"SectionName":"String","PersistentFormSectionId":"00000000-0000-0000-0000-000000000000","SectionTemplateId":"00000000-0000-0000-0000-000000000000","ParentSectionId":"00000000-0000-0000-0000-000000000000","CollectionType":"All","CollectionId":"00000000-0000-0000-0000-000000000000","CollectionName":"String","Confidential":false}]}