Resource: Swagger API ( /api/swagger/api )
Retrieves the Swagger documentation for the Enterprise Tester Core REST API.
Root Relation: SwaggerCoreAPI
This resource supports the following methods: GET
Methods
GET
Retrieves the swagger definition for the core API.
Status Codes
These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
Example - GET
Retrieve the Swagger JSON for the API
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-type | application/json | |
| Accept | application/json |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"apiVersion": "5.0.0.0",
"swaggerVersion": "1.1",
"basePath": "http://localhost:8092/EnterpriseTester/",
"apis": [
{
"path": "/api/",
"description": "Returns root-level response listing available resources.",
"operations": [
{
"httpMethod": "GET",
"nickname": "root",
"responseClass": "Resources",
"summary": "Retrieves the list of available root-level resources.",
"notes": "Expanders:",
"statusCodes": {
"200": "Returned if the request was completed successfully."
}
}
]
},
{
"path": "/api/users",
"description": "Allows the search and retrieval of users.",
"operations": [
{
"httpMethod": "GET",
"nickname": "users",
"responseClass": "QueryResultsOfUser",
"summary": "Retrieves all (or a subset) of users.",
"notes": "Expanders:DisplayName, Groups",
"statusCodes": {
"200": "Returned if the request was completed successfully."
}
},
{
"httpMethod": "POST",
"nickname": "users",
"responseClass": "User",
"summary": "Create a new user",
"notes": "Expanders:",
"parameters": [
{
"paramType": "body",
"name": "model",
"dataType": "CreateOrUpdateUser",
"required": false,
"allowMultiple": false
}
],
"statusCodes": {
"200": "Returned if the request was completed successfully.",
"403": "Returned if request contained invalid data or would cause a conflict with an existing user record.",
"404": "Returned if user does not exists."
}
}
]
},
...
]
}
|
Status Code
200 - OK