This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Creates an ontology scenario.
Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read api:ontologies-write.
stringThe API name or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or check the Ontology Manager.
booleanoptionalA boolean flag that, when set to true, enables the use of beta features in preview mode.
objectThe request payload for creating an ontology scenario.
unionoptionalThe base used to initialize a scenario.
stringoptionalThe date after which the scenario expires and is automatically cleaned up. Defaults to 31 days after creation. Must be after creation and no later than 31 days after creation.
objectSuccessfully created a scenario.
stringThe unique resource identifier of an ontology scenario.
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/ontologies/palantir/scenarios/create?preview=true" \
-d '{"base":{"type":"branch","branch":"my-branch"}}'1
2
3
{
"scenarioRid": "ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48"
}