Transition requirement
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/transition \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '{}'const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/transition', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/transition"
payload = {}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"category": "<string>",
"id": 123,
"display_id": 123,
"account_id": 123,
"requirement_type": "<string>",
"status": "<string>",
"priority": "<string>",
"source": "<string>",
"title": "<string>",
"description": "<string>",
"responsible_party": "<string>",
"approval_status": "<string>",
"cost_estimate": 123,
"property_id": 123,
"conversation_id": 123,
"assignee_id": 123,
"reporter_contact_id": 123,
"duplicate_of_id": 123,
"approval_required": true,
"sign_off_required": true,
"created_at": "<string>",
"updated_at": "<string>"
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{}Requirements
Transition requirement
Drive the requirement state machine through Requirements::TransitionService. Allowed events are triage, request_approval, approve, reject, start, resolve, sign_off, close, cancel and reopen.
POST
/
api
/
v1
/
accounts
/
{account_id}
/
requirements
/
{id}
/
transition
Transition requirement
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/transition \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '{}'const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/transition', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/transition"
payload = {}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"category": "<string>",
"id": 123,
"display_id": 123,
"account_id": 123,
"requirement_type": "<string>",
"status": "<string>",
"priority": "<string>",
"source": "<string>",
"title": "<string>",
"description": "<string>",
"responsible_party": "<string>",
"approval_status": "<string>",
"cost_estimate": 123,
"property_id": 123,
"conversation_id": 123,
"assignee_id": 123,
"reporter_contact_id": 123,
"duplicate_of_id": 123,
"approval_required": true,
"sign_off_required": true,
"created_at": "<string>",
"updated_at": "<string>"
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{}Authorizations
Path Parameters
ID of the requirement
The numeric ID of the account
Body
application/json
Transition event
Available options:
triage, request_approval, approve, reject, start, resolve, sign_off, close, cancel, reopen Decision note recorded on the requirement event
Required for the triage event
Optional internal classification for triage, selected from classification_options in the detail response. Must belong to the current public category. Terms are calculated from the original filing date.
Optional cost estimate for the triage event
Target status for the reopen event
Response
Success
Public category resolved by the account country catalog; display labels are localized by the client.