All pages
Powered by GitBook
1 of 11

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Record/Replay APIs

Start Recording

Start recording.

POST /record/{policyId}/recording/start

Start recording. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

policyId*

String

Policy ID

*

Object

Object that contains options

content:
            application/json:
              schema:
                type: boolean
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

Get Recording

Get recording or running status.

GET /record/{policyId}/status

Get recording or running status. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

policyId*

String

Policy ID

*

Object

Object that contains options

content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordStatusDTO'
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

Get Recorded Actions

Get recorded actions.

GET /record/{policyId}/recording/actions

Get recorded actions. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

Skip Step

Skip step.

POST /record/{policyId}/running/skip

Skip step. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

policyId*

String

Policy ID

*

Object

Object that contains options

content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecordActionDTO'
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

policyId*

String

Policy ID

*

Object

Object that contains options

content:
            application/json:
              schema:
                type: boolean
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

Fast Forward

Fast Forward.

POST /record/{policyId}/running/fast-forward

Fast Forward. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

policyId*

String

Policy ID

*

String

Object that contains options

content:
            application/json:
              schema:
                type: boolean
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

Retry Step

Retry step.

POST /record/{policyId}/running/retry

Retry step. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

Get Running Results

Get running results.

GET /record/{policyId}/running/results

Get running results. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

policyId*

String

Policy ID

*

Object

Object that contains options

content:
            application/json:
              schema:
                type: boolean
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

policyId*

String

Policy ID

*

String

Object that contains options

content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunningResultDTO'
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

Run record from zip file

Run record from a zip file.

POST /record/{policyId}/running/start

Run record from a zip file. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

policyId*

String

Policy ID

*

String

A zip file containing record to be run.

content:
            application/json:
              schema:
                type: boolean
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

Stop Running

Stop running.

POST /record/{policyId}/running/stop

Stop running. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

policyId*

String

Policy ID

*

String

Object that contains options

content:
            application/json:
              schema:
                type: boolean
 content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

Stop Recording

Stop recording.

POST /record/{policyId}/recording/stop

Stop recording. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

policyId*

String

Policy ID

*

Object

Object that contains options

content:
            application/json:
              schema:
                type: string
                format: binary
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'