Update a test plan
patch
/fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}/child/testPlans/{TestPlanId}
Request
Path Parameters
-
ControlId(required): integer(int64)
The unique identifier of a control.
-
TestPlanId(required): integer(int64)
Unique identifier of the test plan.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ControlId: integer
(int64)
The unique identifier for the control the plan is created to test.
-
DetailedDescription: string
(byte)
Title:
Description
The detailed description of the test plan. -
Name: string
Title:
Test Plan Name
Maximum Length:150
The name of the test plan. -
planActivity: array
Test Plan Activity Type
Title:
Test Plan Activity Type
The test plan activity type resource is used to correlate each test plan with an assessment activity. The plan is completed only during an assessment of that type. -
SampleSize: integer
(int32)
Title:
Sample Size
The number of control-enforcement instances to be examined for the plan to be completed. -
steps: array
Steps
Title:
Steps
The steps resource is used to view or modify individual steps within test plans. -
TestPlanFrequency: string
Title:
Test Frequency
Maximum Length:30
Whether the test plan is to be run daily, weekly, monthly, or annually. -
TestPlanId: integer
(int64)
Title:
Record ID
Unique identifier of the test plan.
Nested Schema : Test Plan Activity Type
Type:
array
Title:
Test Plan Activity Type
The test plan activity type resource is used to correlate each test plan with an assessment activity. The plan is completed only during an assessment of that type.
Show Source
Nested Schema : Steps
Type:
array
Title:
Steps
The steps resource is used to view or modify individual steps within test plans.
Show Source
Nested Schema : frcControls-testPlans-planActivity-item-patch-request
Type:
Show Source
object
-
ActivityCode: string
Maximum Length:
30
A code for the assessment activity in support of which the test plan is carried out. -
ControlId: integer
(int64)
The unique identifier of the control to which this test plan activity is related.
-
TestPlanId: integer
(int64)
The unique identifier of the test plan.
Nested Schema : frcControls-testPlans-steps-item-patch-request
Type:
Show Source
object
-
DetailedDescription: string
(byte)
The detailed description of the test step.
-
StepId: integer
(int64)
The unique identifier for the test step.
-
StepOrder: integer
(int32)
Default Value:
1
The logical order of the test step. -
TestPlanId: integer
(int64)
The unique identifier for the test plan the step is a part of.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : frcControls-testPlans-item-response
Type:
Show Source
object
-
ControlId: integer
(int64)
The unique identifier for the control the plan is created to test.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the test plan. -
CreationDate: string
(date-time)
Read Only:
true
the date and time the test plan was created. -
DetailedDescription: string
(byte)
Title:
Description
The detailed description of the test plan. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the test plan was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The last user who updated the test plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Test Plan Name
Maximum Length:150
The name of the test plan. -
planActivity: array
Test Plan Activity Type
Title:
Test Plan Activity Type
The test plan activity type resource is used to correlate each test plan with an assessment activity. The plan is completed only during an assessment of that type. -
RevisionDate: string
(date-time)
Read Only:
true
The date when the test plan was most recently revised. -
SampleSize: integer
(int32)
Title:
Sample Size
The number of control-enforcement instances to be examined for the plan to be completed. -
steps: array
Steps
Title:
Steps
The steps resource is used to view or modify individual steps within test plans. -
TestPlanFrequency: string
Title:
Test Frequency
Maximum Length:30
Whether the test plan is to be run daily, weekly, monthly, or annually. -
TestPlanId: integer
(int64)
Title:
Record ID
Unique identifier of the test plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Test Plan Activity Type
Type:
array
Title:
Test Plan Activity Type
The test plan activity type resource is used to correlate each test plan with an assessment activity. The plan is completed only during an assessment of that type.
Show Source
Nested Schema : Steps
Type:
array
Title:
Steps
The steps resource is used to view or modify individual steps within test plans.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : frcControls-testPlans-planActivity-item-response
Type:
Show Source
object
-
ActivityCode: string
Maximum Length:
30
A code for the assessment activity in support of which the test plan is carried out. -
ControlId: integer
(int64)
The unique identifier of the control to which this test plan activity is related.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TestPlanId: integer
(int64)
The unique identifier of the test plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : frcControls-testPlans-steps-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the test step. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the test step was created. -
DetailedDescription: string
(byte)
The detailed description of the test step.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the test step was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who updated the test step most recently. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StepId: integer
(int64)
The unique identifier for the test step.
-
StepOrder: integer
(int32)
Default Value:
1
The logical order of the test step. -
TestPlanId: integer
(int64)
The unique identifier for the test plan the step is a part of.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- planActivity
-
Parameters:
- ControlId:
$request.path.ControlId
- TestPlanId:
$request.path.TestPlanId
The test plan activity type resource is used to correlate each test plan with an assessment activity. The plan is completed only during an assessment of that type. - ControlId:
- steps
-
Operation: /fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}/child/testPlans/{TestPlanId}/child/stepsParameters:
- ControlId:
$request.path.ControlId
- TestPlanId:
$request.path.TestPlanId
The steps resource is used to view or modify individual steps within test plans. - ControlId: