GET /external/api/v3/form/getall?includeArchived={includeArchived}
Get a list of all form names and the corresponding id.
Request Information
URI Parameters
Name | Description | Type | Additional information | Nullable |
---|---|---|---|---|
includeArchived | boolean |
Default value is False |
False |
Body Parameters
None.
Response Information
Resource Description
Collection of BaseFormName | Description | Type | Additional information | Nullable |
---|---|---|---|---|
Id | globally unique identifier |
None |
False | |
Name | string |
None |
False | |
IsConcept | boolean |
None |
False |
Response Formats
application/json, text/json
Sample:
[ { "Id": "e9bb90ff-be51-45e2-af4a-9607994d3712", "Name": "sample string 2", "IsConcept": true }, { "Id": "e9bb90ff-be51-45e2-af4a-9607994d3712", "Name": "sample string 2", "IsConcept": true } ]
application/xml, text/xml
Sample:
<ArrayOfBaseForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Domain.Shared.Models"> <BaseForm> <Id>e9bb90ff-be51-45e2-af4a-9607994d3712</Id> <IsConcept>true</IsConcept> <Name>sample string 2</Name> </BaseForm> <BaseForm> <Id>e9bb90ff-be51-45e2-af4a-9607994d3712</Id> <IsConcept>true</IsConcept> <Name>sample string 2</Name> </BaseForm> </ArrayOfBaseForm>
Response Status Codes
Status Code | Name | Description |
---|---|---|
200 | OK | The request has succeeded. |
400 | Bad Request | Fulfilling the request would cause an invalid state. Request needs modification. |
401 | Unauthorized | Missing or invalid authentication token. |
403 | Forbidden | Server refuses to authorize the request. |
408 | Request Timeout | The server timed out waiting for the request. |
429 | Too Many Requests | Too many requests in a given amount of time. |
500 | Internal Server Error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
503 | Service Unavailable | The server is unable to proces the request at the moment, try again later. |