Skip to content

Get rule

GET
/connection-profiles/{connectionProfileId}/rules/{connectionProfileRuleId}

Get connection profile rule by ID

connectionProfileId
required
integer

ID of the connection profile

connectionProfileRuleId
required
integer

ID of the rule

Successfully retrieved connection profile

object
data
ConnectionProfileRule

Object representing a connection profile rule

object
id

Internal connection profile rule ID

integer
createdAt

Date of rule creation

date
updatedAt

Date of rule update (can be null)

date
action

Rule action

string
Allowed values: pass warn fail
type

Type of rule, custom for customer or based on Advalidation provider

string
Allowed values: custom provider
providerId

If type is provider, this is the ID of the provider

integer
customName

Custom rule name

string
customDescription

Custom rule comment

string

401 Authentication failed

401 Authentication failed response

Unable to authenticate user

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

403 Forbidden

403 Forbidden response

Currently authenticated user does not have permission to access or update requested object

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

404 Not found

404 Not found response

Requested resource or underlying resource was not found

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

422 Unprocessable entity

422 Unprocessable entity

There is something wrong with the content of the request, typically missing or improperly formatted fields

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string