Apply a data source to a requirement

Attaches an already-created backing resource to the requirement. Creating the resource and attaching it are separate acts — create it on its own collection first, then apply it here.
Either party may call this. A payer may apply from any state except while one of their own status overrides stands; a payee may not replace a source the payer applied to a requirement that is already Completed. Neither party may apply while a payer override is in effect — the payer must approve, reject or revert first, because the override decides the requirement's status regardless of which source is attached.
The source must belong to the same payer/payee relationship as the requirement, and must not be one this requirement has already used — the currently attached id and every id in dataSourceHistory are both rejected. On success the previous source is archived to dataSourceHistory with reason: Replaced, dataSourceAppliedBy records the applying party, and requiresFreshDataSource is cleared.
Returns 422 for a requirement type with no independently addressable backing resource, and 409 while the requirement's monitor is paused or cancelled.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the requirement instance

Body Params
string
required

Identifier of an already-created backing resource to attach. Its kind is fixed by the requirement's own type — see dataSource.type — and it must belong to the same payer/payee relationship as the requirement. An id this requirement has already used, including the one currently attached, is rejected with 409 ResourceConflict.

Headers
string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json