Help Center>Foundation Help

REST API Responses By Operation

Operation Result Code Status Response Body
GET Object successfully updated 200 SUCCESS Return the object(s) in the response. If an object id was provided with the request (Get by id) return one object. If no object id was provided with the request (Get All) return all objects in a collection. If the collection is empty, return and empty collection i.e. []
GET Object with the requested id does not exist 404 NOT FOUND None
GET Failure (Server Error) 500 SERVER ERROR Provide basic info about the failure but do NOT provide confidential information such as configuration data. i.e. {"error" : "Bad configuration"}
HEAD Success 204 NO CONTENT None
HEAD Object with the requested id does not exist 404 NOT FOUND None