Get a requirement definition

Retrieves a single requirement definition by ID.

Add ?expand[]=DataSource to inline the backing configuration that dataSourceId addresses, instead of deriving its collection from type and issuing a second call.

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

Unique identifier of the RequirementDefinition (template)

Query Params
expand
array of strings, unique

Inline related resources on a single RequirementDefinition read. Supported value is DataSource — the backing configuration resource that dataSourceId addresses, returned in place of a dataSourceType a caller would otherwise have to derive a collection from. Unsupported values return 422 instead of being silently ignored. Expansions are not available on list/search rows.

Requesting DataSource is never an error: the key is simply omitted when there is nothing to inline — a requirement type that has no configuration, a null dataSourceId, or a configuration resource not yet addressable on V3. A supported value that resolves nothing is a 200 with the key absent; only an unsupported value is a 422.

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
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