Organization validations
Organization validations API overview
The organization validations API allows integrators to manage validation records for organizations in SCM.
The API supports the following actions:
- Submitting validation requests
- Synchronizing validation state with external systems
- Changing assigned validators
- Managing external validation assignments
- Re-submitting validations
- Resetting or removing existing validation records
Validations API endpoints
The following tables group the validations endpoints by functionality.
Click any action in the first column to open its API reference page.
1. Validation listing & details
| Action | Method | Path | Description |
|---|---|---|---|
| List validations for an organization | GET | /api/organization/v2/{orgId}/validations | Retrieve all validations associated with the specified organization. |
| Get validation details | GET | /api/organization/v2/{orgId}/validations/{validationId} | Retrieve detailed validation information for a specific validation. |
2. Submitting & synchronizing validations
| Action | Method | Path | Description |
|---|---|---|---|
| Submit validation | POST | /api/organization/v2/{orgId}/validations/submit | Submit organization data for validation. |
| Synchronize validation | POST | /api/organization/v2/{orgId}/validations/{validationId}/sync | Synchronize a validation with the external validation backend. |
3. Validator assignment
| Action | Method | Path | Description |
|---|---|---|---|
| Change a validator | PUT | /api/organization/v2/{orgId}/validations/{validationId}/validator | Change the validator assigned to this validation. |
4. External validation assignment
| Action | Method | Path | Description |
|---|---|---|---|
| Create external validation assignment | POST | /api/organization/v2/{orgId}/validations/assignment | Create a mapping between this organization and an external validation organization. |
| Change external validation assignment | PUT | /api/organization/v2/{orgId}/validations/assignment/{validationId} | Update the assigned external organization's validation. |
5. Re-submit & reset validations
| Action | Method | Path | Description |
|---|---|---|---|
| Re-submit the validation | PUT | /api/organization/v2/{orgId}/validations/{validationId}/revalidate | Re-submit the validation using orgId and validationId. |
| Reset and remove the validation | DELETE | /api/organization/v2/{orgId}/validations/{validationId} | Reset the validation state and remove the validation record. |
Updated 8 months ago
Did this page help you?