List all usecases

GET 
https://api.pharia.example.com/v1/os/usecases

List all usecases

Request

Query Parameters

filter string

UsecaseFilter is a struct that contains the filter fields for the usecase example: {"name":"test"}

limit int
Default value: 10
page int
Default value: 1

Responses

200

OK

application/json

Schema

Schema

data object[]required
Array [
createdAtstringrequired
deployment objectnullable
createdAtstringrequired
idstringrequired
messagestringrequired
This field is meant to be populated with any errors that might happen during deployment.
statusstringrequired
Current deployment status
Possible values: [pending, undeploying, undeployed, deploying, deployed, error, superseded]
urlstringrequired
The URL that the usecase can be reached with.
descriptionstringrequired
idstringrequired
namestringrequired
]
limitintegerrequired
pageintegerrequired
totalintegerrequired

Example (auto)

{
  "data": [
    {
      "createdAt": "string",
      "deployment": {
        "createdAt": "string",
        "id": "string",
        "message": "string",
        "status": "pending",
        "url": "string"
      },
      "description": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "limit": 0,
  "page": 0,
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

detailstring
Example: Bad Request
instancestring
Example: https://api.example.com/docs/errors/400
statusinteger
Example: 400
titlestring
Example: Bad Request
typestring

Example (auto)

{
  "detail": "Bad Request",
  "instance": "https://api.example.com/docs/errors/400",
  "status": 400,
  "title": "Bad Request",
  "type": "string"
}

401

Unauthorized

application/json

Schema

Schema

detailstring
Example: Unauthorized
instancestring
Example: https://api.example.com/docs/errors/401
statusinteger
Example: 401
titlestring
Example: Unauthorized
typestring

Example (auto)

{
  "detail": "Unauthorized",
  "instance": "https://api.example.com/docs/errors/401",
  "status": 401,
  "title": "Unauthorized",
  "type": "string"
}

403

Forbidden

application/json

Schema

Schema

detailstring
Example: Forbidden
instancestring
Example: https://api.example.com/docs/errors/403
statusinteger
Example: 403
titlestring
Example: Forbidden
typestring

Example (auto)

{
  "detail": "Forbidden",
  "instance": "https://api.example.com/docs/errors/403",
  "status": 403,
  "title": "Forbidden",
  "type": "string"
}

500

Internal Server Error

application/json

Schema

Schema

detailstring
Example: Internal Server Error
instancestring
Example: https://api.example.com/docs/errors/500
statusinteger
Example: 500
titlestring
Example: Internal Server Error
typestring

Example (auto)

{
  "detail": "Internal Server Error",
  "instance": "https://api.example.com/docs/errors/500",
  "status": 500,
  "title": "Internal Server Error",
  "type": "string"
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://docs.aleph-alpha.com/usecases");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.pharia.example.com/v1/os

Parameters

filter — query

limit — query

page — query

ResponseClear

Click the Send API Request button above and see the response here!