Jump to

• Request
• Response

Create a test plan

post

/fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}/child/testPlans

Request

Path Parameters

• ControlId(required): integer(int64)
  The unique identifier of a control.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ControlId(required): 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(required): 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(required): integer (int64)
  Title: Record ID

  Unique identifier of the test plan.

{
    "required":[
        "ControlId",
        "Name",
        "TestPlanId"
    ],
    "type":"object",
    "properties":{
        "TestPlanId":{
            "title":"Record ID",
            "type":"integer",
            "description":"Unique identifier of the test plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GRC_CTRL_TESTPLAN_S"
            }
        },
        "SampleSize":{
            "title":"Sample Size",
            "type":"integer",
            "description":"The number of control-enforcement instances to be examined for the plan to be completed.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "TestPlanFrequency":{
            "title":"Test Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"Whether the test plan is to be run daily, weekly, monthly, or annually.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ControlId":{
            "type":"integer",
            "description":"The unique identifier for the control the plan is created to test.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "planActivity":{
            "title":"Test Plan Activity Type",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/frcControls-testPlans-planActivity-item-post-request"
            }
        },
        "steps":{
            "title":"Steps",
            "type":"array",
            "description":"The steps resource is used to view or modify individual steps within test plans.",
            "items":{
                "$ref":"#/components/schemas/frcControls-testPlans-steps-item-post-request"
            }
        },
        "DetailedDescription":{
            "title":"Description",
            "type":"string",
            "description":"The detailed description of the test plan.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Test Plan Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the test plan.",
            "nullable":false
        }
    }
}

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

• Array of: object schema

{
    "title":"Test Plan Activity Type",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/frcControls-testPlans-planActivity-item-post-request"
    }
}

Nested Schema : Steps

Type: array

Title: Steps

The steps resource is used to view or modify individual steps within test plans.

Show Source

• Array of: object schema

{
    "title":"Steps",
    "type":"array",
    "description":"The steps resource is used to view or modify individual steps within test plans.",
    "items":{
        "$ref":"#/components/schemas/frcControls-testPlans-steps-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TestPlanId":{
            "type":"integer",
            "description":"The unique identifier of the test plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"A code for the assessment activity in support of which the test plan is carried out.",
            "nullable":false
        },
        "ControlId":{
            "type":"integer",
            "description":"The unique identifier of the control to which this test plan activity is related.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TestPlanId":{
            "type":"integer",
            "description":"The unique identifier for the test plan the step is a part of.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StepOrder":{
            "type":"integer",
            "description":"The logical order of the test step.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"4"
            }
        },
        "StepId":{
            "type":"integer",
            "description":"The unique identifier for the test step.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GTG_CTRL_STEP_S"
            }
        },
        "DetailedDescription":{
            "type":"string",
            "description":"The detailed description of the test step.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : frcControls-testPlans-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The last user who updated the test plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TestPlanId":{
            "title":"Record ID",
            "type":"integer",
            "description":"Unique identifier of the test plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GRC_CTRL_TESTPLAN_S"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"the date and time the test plan was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the test plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "planActivity":{
            "title":"Test Plan Activity Type",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/frcControls-testPlans-planActivity-item-response"
            }
        },
        "steps":{
            "title":"Steps",
            "type":"array",
            "description":"The steps resource is used to view or modify individual steps within test plans.",
            "items":{
                "$ref":"#/components/schemas/frcControls-testPlans-steps-item-response"
            }
        },
        "Name":{
            "title":"Test Plan Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the test plan.",
            "nullable":false,
            "x-queryable":true
        },
        "RevisionDate":{
            "type":"string",
            "description":"The date when the test plan was most recently revised.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SampleSize":{
            "title":"Sample Size",
            "type":"integer",
            "description":"The number of control-enforcement instances to be examined for the plan to be completed.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "TestPlanFrequency":{
            "title":"Test Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"Whether the test plan is to be run daily, weekly, monthly, or annually.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ControlId":{
            "type":"integer",
            "description":"The unique identifier for the control the plan is created to test.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DetailedDescription":{
            "title":"Description",
            "type":"string",
            "description":"The detailed description of the test plan.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time the test plan was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object frcControls-testPlans-planActivity-item-response

{
    "title":"Test Plan Activity Type",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/frcControls-testPlans-planActivity-item-response"
    }
}

Nested Schema : Steps

Type: array

Title: Steps

The steps resource is used to view or modify individual steps within test plans.

Show Source

• Array of: object frcControls-testPlans-steps-item-response

{
    "title":"Steps",
    "type":"array",
    "description":"The steps resource is used to view or modify individual steps within test plans.",
    "items":{
        "$ref":"#/components/schemas/frcControls-testPlans-steps-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : frcControls-testPlans-planActivity-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TestPlanId":{
            "type":"integer",
            "description":"The unique identifier of the test plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActivityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"A code for the assessment activity in support of which the test plan is carried out.",
            "nullable":false,
            "x-queryable":true
        },
        "ControlId":{
            "type":"integer",
            "description":"The unique identifier of the control to which this test plan activity is related.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : frcControls-testPlans-steps-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who updated the test step most recently.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TestPlanId":{
            "type":"integer",
            "description":"The unique identifier for the test plan the step is a part of.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the test step was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the test step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StepId":{
            "type":"integer",
            "description":"The unique identifier for the test step.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GTG_CTRL_STEP_S"
            },
            "x-queryable":true
        },
        "StepOrder":{
            "type":"integer",
            "description":"The logical order of the test step.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DetailedDescription":{
            "type":"string",
            "description":"The detailed description of the test step.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the test step was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

planActivity

Operation: /fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}/child/testPlans/{TestPlanId}/child/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.

steps

Operation: /fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}/child/testPlans/{TestPlanId}/child/steps

Parameters:

• ControlId: $request.path.ControlId
• TestPlanId: $request.path.TestPlanId

The steps resource is used to view or modify individual steps within test plans.

Back to Top