Foundry API

<back to all web services

SearchAllWarningsRequest

Requires Authentication
The following routes are available for this service:
GET/warnings
SearchAllWarningsRequest Parameters:
NameParameterData TypeRequiredDescription
MachineIdquerystringNo
StartAtqueryDateTimeNo
ResolvedAtqueryDateTimeNo
SearchOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
SearchOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
DistinctformstringNo
Limitformint?No
Offsetformint?No
SortformstringNo
FilterformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
SearchAllWarningsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
WarningsformList<Warning>No
SearchOperationResponse Parameters:
NameParameterData TypeRequiredDescription
MetadataformSearchMetadataNo
SearchMetadata Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
LimitformintNo
OffsetformintNo
SortformSortingNo
FilterformFilteringNo
Sorting Parameters:
NameParameterData TypeRequiredDescription
ByformstringNo
DirectionformSortDirectionNo
SortDirection Enum:
Ascending
Descending
Filtering Parameters:
NameParameterData TypeRequiredDescription
FieldsformList<string>No
Warning Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
MachineIdformstringNo
TypeformstringNo
StartedAtformDateTimeNo
ResolvedAtformDateTimeNo
DescriptionformstringNo
SearchAllWarningsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
WarningsformList<Warning>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /warnings HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"warnings":[{"id":"String","machineId":"String","type":"String","description":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"]}}}