Workflow Variable
List Workflow Variable
Endpoint to list all Workflow Variable items
post/workflow-variable/get-list
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"query": {
"createdAt": {
"_type": "GreaterThan",
"value": "2026-01-01T00:00:00.000Z"
},
"name": {
"_type": "Search",
"value": "example"
}
},
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true,
"variableType": true,
"oauthGrantType": true,
"oauthClientAuthenticationMethod": true
},
"sort": {
"createdAt": "DESC"
}
}Response
Successful response
Example response
{
"data": [
{
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"workflowId": "123e4567-e89b-12d3-a456-426614174000",
"name": "Example short text",
"description": "This is an example of longer text content that might be stored in this field.",
"isSecret": true,
"variableType": "OAuth 2.0",
"oauthGrantType": "Client Credentials",
"oauthTokenUrl": "https://www.example.com/path/to/resource?param=value",
"oauthClientId": "12345678-1234-1234-1234-123456789012",
"oauthScope": "https://graph.microsoft.com/.default",
"oauthAdditionalParameters": {
"key": "value",
"nested": {
"data": 123
}
},
"oauthClientAuthenticationMethod": "HTTP Basic Header",
"oauthAccessTokenExpiresAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"oauthLastRefreshedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"oauthLastRefreshError": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
"oauthLastRefreshErrorAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.