latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
ResourceDefinition
MatchingCriteria

Add a new Matching Criteria to a Resource Definition.

Matching Criteria are combined with Resource Type to select a specific definition. Matching Criteria can be set for any combination of Application ID, Environment ID, Environment Type, and Resource ID. In the event of multiple matches, the most specific match is chosen.

For example, given 3 sets of matching criteria for the same type:

 1. {"env_type":"test"}
 2. {"env_type":"development"}
 3. {"env_type":"test", "app_id":"my-app"}

If, a resource of that type was needed in an Application my-app, Environment qa-team with Type test and Resource ID modules.my-module-externals.my-resource, there would be two resource definitions matching the criteria: #1 & #3. Definition #3 will be chosen because its matching criteria is the most specific.

post/orgs/{orgId}/resources/defs/{defId}/criteria

Path parameters

orgIdstring required

The Organization ID.

defIdstring required

The Resource Definition ID.

Request body

app_idstring

(Optional) The ID of the Application that the Resources should belong to.

classstring

(Optional) The class of the Resource in the Deployment Set. Can not be empty, if is not defined, set to default.

env_idstring

(Optional) The ID of the Environment that the Resources should belong to. If env_type is also set, it must match the Type of the Environment for the Criteria to match.

env_typestring

(Optional) The Type of the Environment that the Resources should belong to. If env_id is also set, it must have an Environment Type that matches this parameter for the Criteria to match.

res_idstring

(Optional) The ID of the Resource in the Deployment Set. The ID is normally a . separated path to the definition in the set, e.g. modules.my-module.externals.my-database.

Response

The newly added Matching Criteria details.

app_idstring

(Optional) The ID of the Application that the Resources should belong to.

classstring required

(Optional) The class of the Resource in the Deployment Set. Can not be empty, if is not defined, set to default.

env_idstring

(Optional) The ID of the Environment that the Resources should belong to. If env_type is also set, it must match the Type of the Environment for the Criteria to match.

env_typestring

(Optional) The Type of the Environment that the Resources should belong to. If env_id is also set, it must have an Environment Type that matches this parameter for the Criteria to match.

idstring required

Matching Criteria ID

res_idstring

(Optional) The ID of the Resource in the Deployment Set. The ID is normally a . separated path to the definition in the set, e.g. modules.my-module.externals.my-database.