Review / Assignment Rules

Query assignment rules

get

Search and filter assignment rules by various criteria including target type (pool or environment)

Authorizations

bearer

Query parameters

repositoryIdentifierstringOptional

Filter by repository

Example: flxbl-io/sf-core

poolTagstringOptional

Filter by pool tag

Example: feature_dev

targetTypestring · enumOptional

Filter by target type (pool or environment)

Possible values:

isActivebooleanOptional

Filter by active status

Example: true

branchPatternSearchstringOptional

Search in branch patterns

Example: feature

domainPatternSearchstringOptional

Search in domain patterns

Example: staging

Responses

200

List of assignment rules

application/json

idstringRequired

Unique identifier for the assignment

Example: rpa_1234567890

repositoryIdentifierstringRequired

Repository identifier

Example: flxbl-io/sf-core

targetTypestring · enumRequired

Target type: pool or environment

Example: poolPossible values:

poolTagstringOptional

Pool tag assigned (when targetType is pool)

Example: feature_dev

poolTypestring · enumOptional

Type of pool (SANDBOX or SCRATCH_ORG)

Example: SANDBOXPossible values:

environmentNamestringOptional

Dedicated environment name (when targetType is environment)

Example: my-review-env

branchPatternstringRequired

Branch pattern

Example: feature/*

domainPatternstringOptionalDeprecated

Domain pattern - DEPRECATED: Use domainPatterns instead

Example: sales

domainPatternsstring[]Required

Domain patterns

Example: ["sales","service"]

prioritynumberRequired

Priority for conflict resolution

Example: 10

descriptionstringOptional

Description of the rule

Example: Feature branches use the development pool

isActivebooleanRequired

Whether the rule is active

Example: true

createdAtstringRequired

Creation timestamp

Example: 2025-01-01T12:00:00Z

updatedAtstringRequired

Last update timestamp

Example: 2025-01-02T12:00:00Z

createdBystringRequired

User who created the assignment

Example: [email protected]

updatedBystringOptional

User who last updated the assignment

Example: [email protected]

versionnumberRequired

Document version for optimistic locking

Example: 1

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/review/pools/assign

HTTPcURLJavaScriptPython

GET /sfp/api/review/pools/assign HTTP/1.1
Accept: */*

[
  {
    "id": "rpa_1234567890",
    "repositoryIdentifier": "flxbl-io/sf-core",
    "targetType": "pool",
    "poolTag": "feature_dev",
    "poolType": "SANDBOX",
    "environmentName": "my-review-env",
    "branchPattern": "feature/*",
    "domainPatterns": [
      "sales",
      "service"
    ],
    "priority": 10,
    "description": "Feature branches use the development pool",
    "isActive": true,
    "createdAt": "2025-01-01T12:00:00Z",
    "updatedAt": "2025-01-02T12:00:00Z",
    "createdBy": "[email protected]",
    "updatedBy": "[email protected]",
    "version": 1
  }
]

Create an assignment rule

post

Creates a new rule for automatically assigning a pool or dedicated environment to review environments based on branch and domain patterns. Set targetType to "pool" to assign from a pool, or "environment" to assign a dedicated environment.

Authorizations

bearer

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

targetTypestring · enumOptional

Target type: pool (default) or environment for dedicated org assignment

Default: poolPossible values:

poolTagstringOptional

Tag of the pool to assign for matching patterns. Required when targetType is pool.

Example: feature_dev

poolTypestring · enumOptional

Type of pool (SANDBOX or SCRATCH_ORG). If not specified, will be detected from the pool configuration.

Example: SANDBOXPossible values:

environmentNamestringOptional

Name of a dedicated environment to assign. Required when targetType is environment.

Example: my-review-env

branchPatternstringRequired

Git branch pattern to match (supports wildcards: , prefix/, *suffix)

Example: main

domainPatternstringOptionalDeprecated

Domain pattern to match (supports wildcards) - DEPRECATED: Use domainPatterns instead

Example: *

domainPatternsstring[]Optional

Domain patterns to match (supports wildcards, leave empty to match any domain)

Example: ["sales"]

prioritynumber · max: 1000Required

Priority for conflict resolution. Higher values take precedence.

Example: 10

descriptionstringOptional

Optional description explaining the assignment rule

Example: Feature branches use the development pool for any domain

isActivebooleanOptional

Whether this assignment rule is active

Default: true

Responses

201

Assignment rule created successfully

application/json

400

Invalid pattern or request data

403

Forbidden - Requires role: owner, application

404

Pool or environment not found

409

Duplicate rule exists

post

/sfp/api/review/pools/assign

HTTPcURLJavaScriptPython

POST /sfp/api/review/pools/assign HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 295

{
  "repositoryIdentifier": "flxbl-io/sf-core",
  "targetType": "pool",
  "poolTag": "feature_dev",
  "poolType": "SANDBOX",
  "environmentName": "my-review-env",
  "branchPattern": "main",
  "domainPatterns": [
    "sales"
  ],
  "priority": 10,
  "description": "Feature branches use the development pool for any domain",
  "isActive": true
}

{
  "id": "rpa_1234567890",
  "repositoryIdentifier": "flxbl-io/sf-core",
  "targetType": "pool",
  "poolTag": "feature_dev",
  "poolType": "SANDBOX",
  "environmentName": "my-review-env",
  "branchPattern": "feature/*",
  "domainPatterns": [
    "sales",
    "service"
  ],
  "priority": 10,
  "description": "Feature branches use the development pool",
  "isActive": true,
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-02T12:00:00Z",
  "createdBy": "[email protected]",
  "updatedBy": "[email protected]",
  "version": 1
}

Test pattern matching

post

Test which pool or environment would be assigned for a given repository, branch, and domain combination

Authorizations

bearer

Body

application/json

repositoryIdentifierstringRequired

Repository identifier

Example: flxbl-io/sf-core

branchstringRequired

Branch to test

Example: feature/ABC-123

domainsstring[]Optional

Domains to test (supports multiple domains)

Example: ["sales","service"]

Responses

200

Pattern matching test results

application/json

matchedbooleanRequired

Whether a match was found

Example: true

targetTypestring · enumOptional

Target type of the best match

Possible values:

poolTagstringOptional

Matched pool tag (when targetType is pool)

Example: feature_dev

environmentNamestringOptional

Matched environment name (when targetType is environment)

Example: my-review-env

testParamsobjectRequired

Test parameters used

403

Forbidden - Requires role: owner, application

post

/sfp/api/review/pools/assign/test

HTTPcURLJavaScriptPython

POST /sfp/api/review/pools/assign/test HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "repositoryIdentifier": "flxbl-io/sf-core",
  "branch": "feature/ABC-123",
  "domains": [
    "sales",
    "service"
  ]
}

{
  "matched": true,
  "targetType": "pool",
  "poolTag": "feature_dev",
  "environmentName": "my-review-env",
  "assignment": {
    "id": "rpa_1234567890",
    "repositoryIdentifier": "flxbl-io/sf-core",
    "targetType": "pool",
    "poolTag": "feature_dev",
    "poolType": "SANDBOX",
    "environmentName": "my-review-env",
    "branchPattern": "feature/*",
    "domainPatterns": [
      "sales",
      "service"
    ],
    "priority": 10,
    "description": "Feature branches use the development pool",
    "isActive": true,
    "createdAt": "2025-01-01T12:00:00Z",
    "updatedAt": "2025-01-02T12:00:00Z",
    "createdBy": "[email protected]",
    "updatedBy": "[email protected]",
    "version": 1
  },
  "matches": [
    {
      "assignment": {
        "id": "rpa_1234567890",
        "repositoryIdentifier": "flxbl-io/sf-core",
        "targetType": "pool",
        "poolTag": "feature_dev",
        "poolType": "SANDBOX",
        "environmentName": "my-review-env",
        "branchPattern": "feature/*",
        "domainPatterns": [
          "sales",
          "service"
        ],
        "priority": 10,
        "description": "Feature branches use the development pool",
        "isActive": true,
        "createdAt": "2025-01-01T12:00:00Z",
        "updatedAt": "2025-01-02T12:00:00Z",
        "createdBy": "[email protected]",
        "updatedBy": "[email protected]",
        "version": 1
      },
      "branchScore": 1,
      "domainScore": 1,
      "totalScore": 1
    }
  ],
  "testParams": {}
}

Get an assignment rule by ID

get

Authorizations

bearer

Path parameters

idstringRequired

Assignment rule ID

Responses

200

Assignment rule details

application/json

idstringRequired

Unique identifier for the assignment

Example: rpa_1234567890

repositoryIdentifierstringRequired

Repository identifier

Example: flxbl-io/sf-core

targetTypestring · enumRequired

Target type: pool or environment

Example: poolPossible values:

poolTagstringOptional

Pool tag assigned (when targetType is pool)

Example: feature_dev

poolTypestring · enumOptional

Type of pool (SANDBOX or SCRATCH_ORG)

Example: SANDBOXPossible values:

environmentNamestringOptional

Dedicated environment name (when targetType is environment)

Example: my-review-env

branchPatternstringRequired

Branch pattern

Example: feature/*

domainPatternstringOptionalDeprecated

Domain pattern - DEPRECATED: Use domainPatterns instead

Example: sales

domainPatternsstring[]Required

Domain patterns

Example: ["sales","service"]

prioritynumberRequired

Priority for conflict resolution

Example: 10

descriptionstringOptional

Description of the rule

Example: Feature branches use the development pool

isActivebooleanRequired

Whether the rule is active

Example: true

createdAtstringRequired

Creation timestamp

Example: 2025-01-01T12:00:00Z

updatedAtstringRequired

Last update timestamp

Example: 2025-01-02T12:00:00Z

createdBystringRequired

User who created the assignment

Example: [email protected]

updatedBystringOptional

User who last updated the assignment

Example: [email protected]

versionnumberRequired

Document version for optimistic locking

Example: 1

403

Forbidden - Requires role: member, owner, application

404

Assignment rule not found

get

/sfp/api/review/pools/assign/{id}

HTTPcURLJavaScriptPython

GET /sfp/api/review/pools/assign/{id} HTTP/1.1
Accept: */*

{
  "id": "rpa_1234567890",
  "repositoryIdentifier": "flxbl-io/sf-core",
  "targetType": "pool",
  "poolTag": "feature_dev",
  "poolType": "SANDBOX",
  "environmentName": "my-review-env",
  "branchPattern": "feature/*",
  "domainPatterns": [
    "sales",
    "service"
  ],
  "priority": 10,
  "description": "Feature branches use the development pool",
  "isActive": true,
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-02T12:00:00Z",
  "createdBy": "[email protected]",
  "updatedBy": "[email protected]",
  "version": 1
}

Update an assignment rule

put

Update patterns, priority, target, or status of an existing assignment rule

Authorizations

bearer

Path parameters

idstringRequired

Assignment rule ID

Body

application/json

poolTypestring · enumOptional

Type of pool (SANDBOX or SCRATCH_ORG)

Example: SANDBOXPossible values:

branchPatternstringOptional

Git branch pattern to match

Example: feature/*

domainPatternstringOptionalDeprecated

Domain pattern to match - DEPRECATED: Use domainPatterns instead

Example: sales

domainPatternsstring[]Optional

Domain patterns to match (supports wildcards, leave empty to match any domain)

Example: ["sales","service"]

environmentNamestringOptional

Name of dedicated environment (only for environment-targeted rules)

Example: my-review-env

prioritynumber · max: 1000Optional

Priority for conflict resolution

Example: 10

descriptionstringOptional

Optional description explaining the assignment rule

Example: Updated: Feature branches use the development pool

isActivebooleanOptional

Whether this assignment rule is active

Example: true

Responses

200

Assignment rule updated successfully

application/json

idstringRequired

Unique identifier for the assignment

Example: rpa_1234567890

repositoryIdentifierstringRequired

Repository identifier

Example: flxbl-io/sf-core

targetTypestring · enumRequired

Target type: pool or environment

Example: poolPossible values:

poolTagstringOptional

Pool tag assigned (when targetType is pool)

Example: feature_dev

poolTypestring · enumOptional

Type of pool (SANDBOX or SCRATCH_ORG)

Example: SANDBOXPossible values:

environmentNamestringOptional

Dedicated environment name (when targetType is environment)

Example: my-review-env

branchPatternstringRequired

Branch pattern

Example: feature/*

domainPatternstringOptionalDeprecated

Domain pattern - DEPRECATED: Use domainPatterns instead

Example: sales

domainPatternsstring[]Required

Domain patterns

Example: ["sales","service"]

prioritynumberRequired

Priority for conflict resolution

Example: 10

descriptionstringOptional

Description of the rule

Example: Feature branches use the development pool

isActivebooleanRequired

Whether the rule is active

Example: true

createdAtstringRequired

Creation timestamp

Example: 2025-01-01T12:00:00Z

updatedAtstringRequired

Last update timestamp

Example: 2025-01-02T12:00:00Z

createdBystringRequired

User who created the assignment

Example: [email protected]

updatedBystringOptional

User who last updated the assignment

Example: [email protected]

versionnumberRequired

Document version for optimistic locking

Example: 1

400

Invalid pattern or request data

403

Forbidden - Requires role: owner, application

404

Assignment rule not found

409

Duplicate rule would be created

put

/sfp/api/review/pools/assign/{id}

HTTPcURLJavaScriptPython

PUT /sfp/api/review/pools/assign/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "poolType": "SANDBOX",
  "branchPattern": "feature/*",
  "domainPatterns": [
    "sales",
    "service"
  ],
  "environmentName": "my-review-env",
  "priority": 10,
  "description": "Updated: Feature branches use the development pool",
  "isActive": true
}

{
  "id": "rpa_1234567890",
  "repositoryIdentifier": "flxbl-io/sf-core",
  "targetType": "pool",
  "poolTag": "feature_dev",
  "poolType": "SANDBOX",
  "environmentName": "my-review-env",
  "branchPattern": "feature/*",
  "domainPatterns": [
    "sales",
    "service"
  ],
  "priority": 10,
  "description": "Feature branches use the development pool",
  "isActive": true,
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-02T12:00:00Z",
  "createdBy": "[email protected]",
  "updatedBy": "[email protected]",
  "version": 1
}

Delete an assignment rule

delete

Authorizations

bearer

Path parameters

idstringRequired

Assignment rule ID

Responses

204

Assignment rule deleted successfully

404

Assignment rule not found

delete

/sfp/api/review/pools/assign/{id}

HTTPcURLJavaScriptPython

DELETE /sfp/api/review/pools/assign/{id} HTTP/1.1
Accept: */*

No content