curl --request GET \
--url https://app.octavehq.com/api/v2/use-case/get \
--header 'api_key: <api-key>'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"oId": "uc_1234",
"createdAt": "2021-01-01",
"updatedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"name": "Use Case Name",
"internalName": "Use Case Internal Name",
"description": "Use Case Description",
"primaryUrl": "https://www.use-case.com",
"active": true,
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "<string>"
},
"workspace": {
"oId": "<string>"
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
]
}
Get Use Case by OId
curl --request GET \
--url https://app.octavehq.com/api/v2/use-case/get \
--header 'api_key: <api-key>'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"oId": "uc_1234",
"createdAt": "2021-01-01",
"updatedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"name": "Use Case Name",
"internalName": "Use Case Internal Name",
"description": "Use Case Description",
"primaryUrl": "https://www.use-case.com",
"active": true,
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "<string>"
},
"workspace": {
"oId": "<string>"
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
]
}
Use Case OId
Use Case data
The response is of type object
.