Link a record to a requirement
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{requirement_id}/links \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"record_id": 123
}
'const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({record_id: 123})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{requirement_id}/links', 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/{requirement_id}/links"
payload = { "record_id": 123 }
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
Link a record to a requirement
Attach a property or provider contact to a requirement that was filed without them. One act per link, logged to the bitácora.
POST
/
api
/
v1
/
accounts
/
{account_id}
/
requirements
/
{requirement_id}
/
links
Link a record to a requirement
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{requirement_id}/links \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"record_id": 123
}
'const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({record_id: 123})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{requirement_id}/links', 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/{requirement_id}/links"
payload = { "record_id": 123 }
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
Response
Success
Public category resolved by the account country catalog; display labels are localized by the client.