Jump to

• Request
• Response
• Examples

Update a control

patch

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• additionalInformation: array Flexfields
  Title: Flexfields

  The flexfields resource is used to view or modify information added to control definitions in flexfields.
• assertions: array Assertions
  Title: Assertions

  The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control.
• AssessmentFlag: string
  Title: Assessment Testing

  Maximum Length: 1

  Default Value: N

  Whether the control is to be assessed.
• AuditTestingFlag: string
  Title: Audit Testing

  Maximum Length: 1

  Default Value: N

  Whether the control is to be included in audit testing.
• comments: array Comments
  Title: Comments

  The comments resource is used to view or modify comments written about controls.
• ControlCost: number
  Title: Cost

  The estimated cost of implementing the control.
• ControlFrequency: string
  Title: Frequency

  Maximum Length: 30

  How often the control is to be run.
• ControlMethod: string
  Title: Method

  Maximum Length: 40

  Default Value: MANUAL

  Whether the control is automated or manually enforced.
• ControlType: string
  Title: Type

  Maximum Length: 30

  One in a set of user-defined values that may be selected for the control.
• DetailedDescription: string (byte)
  Title: Description

  The detailed description of the control.
• EnforcementType: string
  Title: Enforcement Type

  Maximum Length: 50

  Whether the control detects a risk, corrects it, or prevents if from occurring.
• Name: string
  Title: Name

  Maximum Length: 150

  The name of the control.
• perspectives: array Perspectives
  Title: Perspectives

  The perspectives resource is used to view perspective values assigned to controls or to modify those assignments.
• relatedRisks: array Related Risks
  Title: Related Risks

  The related risks resource is used to view records of risks that are related to the control.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: ACTIVE

  The status of the control. ACTIVE or INACTIVE
• testPlans: array Test Plans
  Title: Test Plans

  The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the control. ACTIVE or INACTIVE",
            "nullable":false,
            "default":"ACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "additionalInformation":{
            "title":"Flexfields",
            "type":"array",
            "description":"The flexfields resource is used to view or modify information added to control definitions in flexfields.",
            "items":{
                "$ref":"#/components/schemas/frcControls-additionalInformation-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "comments":{
            "title":"Comments",
            "type":"array",
            "description":"The comments resource is used to view or modify comments written about controls.",
            "items":{
                "$ref":"#/components/schemas/frcControls-comments-item-patch-request"
            }
        },
        "EnforcementType":{
            "title":"Enforcement Type",
            "maxLength":"50",
            "type":"string",
            "description":"Whether the control detects a risk, corrects it, or prevents if from occurring.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "testPlans":{
            "title":"Test Plans",
            "type":"array",
            "description":"The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective.",
            "items":{
                "$ref":"#/components/schemas/frcControls-testPlans-item-patch-request"
            }
        },
        "AuditTestingFlag":{
            "title":"Audit Testing",
            "maxLength":"1",
            "type":"string",
            "description":"Whether the control is to be included in audit testing.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "relatedRisks":{
            "title":"Related Risks",
            "type":"array",
            "description":"The related risks resource is used to view records of risks that are related to the control.",
            "items":{
                "$ref":"#/components/schemas/frcControls-relatedRisks-item-patch-request"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the control.",
            "nullable":false
        },
        "ControlCost":{
            "title":"Cost",
            "type":"number",
            "description":"The estimated cost of implementing the control.",
            "nullable":true,
            "x-queryable":false
        },
        "AssessmentFlag":{
            "title":"Assessment Testing",
            "maxLength":"1",
            "type":"string",
            "description":"Whether the control is to be assessed.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "perspectives":{
            "title":"Perspectives",
            "type":"array",
            "description":"The perspectives resource is used to view perspective values assigned to controls or to modify those assignments.",
            "items":{
                "$ref":"#/components/schemas/frcControls-perspectives-item-patch-request"
            }
        },
        "ControlType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"One in a set of user-defined values that may be selected for the control.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ControlMethod":{
            "title":"Method",
            "maxLength":"40",
            "type":"string",
            "description":"Whether the control is automated or manually enforced.",
            "nullable":false,
            "default":"MANUAL",
            "x-hints":{
                "controlType":"combo"
            }
        },
        "assertions":{
            "title":"Assertions",
            "type":"array",
            "description":"The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control.",
            "items":{
                "$ref":"#/components/schemas/frcControls-assertions-item-patch-request"
            }
        },
        "ControlFrequency":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"How often the control is to be run.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DetailedDescription":{
            "title":"Description",
            "type":"string",
            "description":"The detailed description of the control.",
            "format":"byte",
            "nullable":true
        }
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The flexfields resource is used to view or modify information added to control definitions in flexfields.

Show Source

• Array of: object frcControls-additionalInformation-item-patch-request

{
    "title":"Flexfields",
    "type":"array",
    "description":"The flexfields resource is used to view or modify information added to control definitions in flexfields.",
    "items":{
        "$ref":"#/components/schemas/frcControls-additionalInformation-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Assertions

Type: array

Title: Assertions

The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control.

Show Source

• Array of: object frcControls-assertions-item-patch-request

{
    "title":"Assertions",
    "type":"array",
    "description":"The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control.",
    "items":{
        "$ref":"#/components/schemas/frcControls-assertions-item-patch-request"
    }
}

Nested Schema : Comments

Type: array

Title: Comments

The comments resource is used to view or modify comments written about controls.

Show Source

• Array of: object frcControls-comments-item-patch-request

{
    "title":"Comments",
    "type":"array",
    "description":"The comments resource is used to view or modify comments written about controls.",
    "items":{
        "$ref":"#/components/schemas/frcControls-comments-item-patch-request"
    }
}

Nested Schema : Perspectives

Type: array

Title: Perspectives

The perspectives resource is used to view perspective values assigned to controls or to modify those assignments.

Show Source

• Array of: object frcControls-perspectives-item-patch-request

{
    "title":"Perspectives",
    "type":"array",
    "description":"The perspectives resource is used to view perspective values assigned to controls or to modify those assignments.",
    "items":{
        "$ref":"#/components/schemas/frcControls-perspectives-item-patch-request"
    }
}

Nested Schema : Related Risks

Type: array

Title: Related Risks

The related risks resource is used to view records of risks that are related to the control.

Show Source

• Array of: object frcControls-relatedRisks-item-patch-request

{
    "title":"Related Risks",
    "type":"array",
    "description":"The related risks resource is used to view records of risks that are related to the control.",
    "items":{
        "$ref":"#/components/schemas/frcControls-relatedRisks-item-patch-request"
    }
}

Nested Schema : Test Plans

Type: array

Title: Test Plans

The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective.

Show Source

• Array of: object frcControls-testPlans-item-patch-request

{
    "title":"Test Plans",
    "type":"array",
    "description":"The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective.",
    "items":{
        "$ref":"#/components/schemas/frcControls-testPlans-item-patch-request"
    }
}

Nested Schema : frcControls-additionalInformation-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  The context of the flexfields associated to the control.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• ControlId: integer (int64)
  Title: Record ID

  The unique identifier of the descriptive flexfield for the control.

{
    "type":"object",
    "properties":{
        "ControlId":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier of the descriptive flexfield for the control.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GRC_CONTROL_S"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "description":"The context of the flexfields associated to the control.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : frcControls-assertions-item-patch-request

Type: object

Show Source

• AssertionCode: string
  Maximum Length: 30

  The code for a control assertion.

{
    "type":"object",
    "properties":{
        "AssertionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code for a control assertion.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : frcControls-comments-item-patch-request

Type: object

Show Source

• Id: integer
  The unique identifier of the comment on the control.
• UserComment: string
  Title: Comment

  Maximum Length: 2000

  The comment made on the control.

{
    "type":"object",
    "properties":{
        "UserComment":{
            "title":"Comment",
            "maxLength":"2000",
            "type":"string",
            "description":"The comment made on the control.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the comment on the control.",
            "nullable":false,
            "x-hints":{
                "GRC::SEQUENCE_NAME":"GRC_COMMENT_S"
            }
        }
    }
}

Nested Schema : frcControls-perspectives-item-patch-request

Type: object

Show Source

• ControlId: integer (int64)
  The unique identifier of the control to which a perspective is assigned.
• PerspItemId: integer (int64)
  The identifier for a perspective value assigned to the control.

{
    "type":"object",
    "properties":{
        "ControlId":{
            "type":"integer",
            "description":"The unique identifier of the control to which a perspective is assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerspItemId":{
            "type":"integer",
            "description":"The identifier for a perspective value assigned to the control.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : frcControls-relatedRisks-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : frcControls-testPlans-item-patch-request

Type: object

Show Source

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

{
    "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-patch-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-patch-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 frcControls-testPlans-planActivity-item-patch-request

{
    "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-patch-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 frcControls-testPlans-steps-item-patch-request

{
    "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-patch-request"
    }
}

Nested Schema : frcControls-testPlans-planActivity-item-patch-request

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 : frcControls-testPlans-steps-item-patch-request

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-item-response

Type: object

Show Source

• additionalInformation: array Flexfields
  Title: Flexfields

  The flexfields resource is used to view or modify information added to control definitions in flexfields.
• ApprovedBy: string
  Read Only: true

  Maximum Length: 64

  The user who approved the control.
• ApprovedDate: string (date-time)
  Title: Approved Date

  Read Only: true

  The date and time when the control was approved.
• assertions: array Assertions
  Title: Assertions

  The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control.
• AssessmentFlag: string
  Title: Assessment Testing

  Maximum Length: 1

  Default Value: N

  Whether the control is to be assessed.
• AuditTestingFlag: string
  Title: Audit Testing

  Maximum Length: 1

  Default Value: N

  Whether the control is to be included in audit testing.
• comments: array Comments
  Title: Comments

  The comments resource is used to view or modify comments written about controls.
• ControlCost: number
  Title: Cost

  The estimated cost of implementing the control.
• ControlFrequency: string
  Title: Frequency

  Maximum Length: 30

  How often the control is to be run.
• ControlId: integer (int64)
  Title: Record ID

  Read Only: true

  The unique identifier of a control.
• ControlMethod: string
  Title: Method

  Maximum Length: 40

  Default Value: MANUAL

  Whether the control is automated or manually enforced.
• ControlType: string
  Title: Type

  Maximum Length: 30

  One in a set of user-defined values that may be selected for the control.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the control was created.
• DetailedDescription: string (byte)
  Title: Description

  The detailed description of the control.
• EnforcementType: string
  Title: Enforcement Type

  Maximum Length: 50

  Whether the control detects a risk, corrects it, or prevents if from occurring.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time of the last update of the control.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who most recently updated the control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 150

  The name of the control.
• perspectives: array Perspectives
  Title: Perspectives

  The perspectives resource is used to view perspective values assigned to controls or to modify those assignments.
• relatedRisks: array Related Risks
  Title: Related Risks

  The related risks resource is used to view records of risks that are related to the control.
• ReviewedBy: string
  Read Only: true

  Maximum Length: 64

  The user who reviewed the control.
• ReviewedDate: string (date-time)
  Title: Reviewed Date

  Read Only: true

  The date and time when the control was reviewed.
• ReviewStartDate: string (date-time)
  Read Only: true

  The date and time when the control review was started.
• RevisionDate: string (date-time)
  Title: Revision Date

  Read Only: true

  The date and time when the control was most recently revised.
• StartDate: string (date-time)
  Read Only: true

  The effective start date of the control.
• StateCode: string
  Title: State

  Read Only: true

  Maximum Length: 30

  Default Value: N

  The state code of the control.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: ACTIVE

  The status of the control. ACTIVE or INACTIVE
• testPlans: array Test Plans
  Title: Test Plans

  The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective.
• TotalRevisions: integer (int32)
  Title: Revision Number

  Read Only: true

  The number of control revisions.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the control was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ReviewedDate":{
            "title":"Reviewed Date",
            "type":"string",
            "description":"The date and time when the control was reviewed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo"
            },
            "x-queryable":true
        },
        "AuditTestingFlag":{
            "title":"Audit Testing",
            "maxLength":"1",
            "type":"string",
            "description":"Whether the control is to be included in audit testing.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the control.",
            "nullable":false,
            "x-queryable":true
        },
        "ControlCost":{
            "title":"Cost",
            "type":"number",
            "description":"The estimated cost of implementing the control.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"The effective start date of the control.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReviewedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who reviewed the control.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "assertions":{
            "title":"Assertions",
            "type":"array",
            "description":"The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control.",
            "items":{
                "$ref":"#/components/schemas/frcControls-assertions-item-response"
            }
        },
        "ControlId":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier of a control.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GRC_CONTROL_S"
            }
        },
        "ControlFrequency":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"How often the control is to be run.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DetailedDescription":{
            "title":"Description",
            "type":"string",
            "description":"The detailed description of the control.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who most recently updated the control.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the control. ACTIVE or INACTIVE",
            "nullable":false,
            "default":"ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "additionalInformation":{
            "title":"Flexfields",
            "type":"array",
            "description":"The flexfields resource is used to view or modify information added to control definitions in flexfields.",
            "items":{
                "$ref":"#/components/schemas/frcControls-additionalInformation-item-response"
            },
            "x-cardinality":"1"
        },
        "comments":{
            "title":"Comments",
            "type":"array",
            "description":"The comments resource is used to view or modify comments written about controls.",
            "items":{
                "$ref":"#/components/schemas/frcControls-comments-item-response"
            }
        },
        "EnforcementType":{
            "title":"Enforcement Type",
            "maxLength":"50",
            "type":"string",
            "description":"Whether the control detects a risk, corrects it, or prevents if from occurring.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date and time when the control was approved.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo"
            },
            "x-queryable":true
        },
        "StateCode":{
            "title":"State",
            "maxLength":"30",
            "type":"string",
            "description":"The state code of the control.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "testPlans":{
            "title":"Test Plans",
            "type":"array",
            "description":"The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective.",
            "items":{
                "$ref":"#/components/schemas/frcControls-testPlans-item-response"
            }
        },
        "relatedRisks":{
            "title":"Related Risks",
            "type":"array",
            "description":"The related risks resource is used to view records of risks that are related to the control.",
            "items":{
                "$ref":"#/components/schemas/frcControls-relatedRisks-item-response"
            }
        },
        "ReviewStartDate":{
            "type":"string",
            "description":"The date and time when the control review was started.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessmentFlag":{
            "title":"Assessment Testing",
            "maxLength":"1",
            "type":"string",
            "description":"Whether the control is to be assessed.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevisionDate":{
            "title":"Revision Date",
            "type":"string",
            "description":"The date and time when the control was most recently revised.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "perspectives":{
            "title":"Perspectives",
            "type":"array",
            "description":"The perspectives resource is used to view perspective values assigned to controls or to modify those assignments.",
            "items":{
                "$ref":"#/components/schemas/frcControls-perspectives-item-response"
            }
        },
        "ApprovedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who approved the control.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalRevisions":{
            "title":"Revision Number",
            "type":"integer",
            "description":"The number of control revisions.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ControlType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"One in a set of user-defined values that may be selected for the control.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ControlMethod":{
            "title":"Method",
            "maxLength":"40",
            "type":"string",
            "description":"Whether the control is automated or manually enforced.",
            "nullable":false,
            "default":"MANUAL",
            "x-hints":{
                "controlType":"combo"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of the last update of the control.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The flexfields resource is used to view or modify information added to control definitions in flexfields.

Show Source

• Array of: object frcControls-additionalInformation-item-response

{
    "title":"Flexfields",
    "type":"array",
    "description":"The flexfields resource is used to view or modify information added to control definitions in flexfields.",
    "items":{
        "$ref":"#/components/schemas/frcControls-additionalInformation-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Assertions

Type: array

Title: Assertions

The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control.

Show Source

• Array of: object frcControls-assertions-item-response

{
    "title":"Assertions",
    "type":"array",
    "description":"The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control.",
    "items":{
        "$ref":"#/components/schemas/frcControls-assertions-item-response"
    }
}

Nested Schema : Comments

Type: array

Title: Comments

The comments resource is used to view or modify comments written about controls.

Show Source

• Array of: object frcControls-comments-item-response

{
    "title":"Comments",
    "type":"array",
    "description":"The comments resource is used to view or modify comments written about controls.",
    "items":{
        "$ref":"#/components/schemas/frcControls-comments-item-response"
    }
}

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 : Perspectives

Type: array

Title: Perspectives

The perspectives resource is used to view perspective values assigned to controls or to modify those assignments.

Show Source

• Array of: object frcControls-perspectives-item-response

{
    "title":"Perspectives",
    "type":"array",
    "description":"The perspectives resource is used to view perspective values assigned to controls or to modify those assignments.",
    "items":{
        "$ref":"#/components/schemas/frcControls-perspectives-item-response"
    }
}

Nested Schema : Related Risks

Type: array

Title: Related Risks

The related risks resource is used to view records of risks that are related to the control.

Show Source

• Array of: object frcControls-relatedRisks-item-response

{
    "title":"Related Risks",
    "type":"array",
    "description":"The related risks resource is used to view records of risks that are related to the control.",
    "items":{
        "$ref":"#/components/schemas/frcControls-relatedRisks-item-response"
    }
}

Nested Schema : Test Plans

Type: array

Title: Test Plans

The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective.

Show Source

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

{
    "title":"Test Plans",
    "type":"array",
    "description":"The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective.",
    "items":{
        "$ref":"#/components/schemas/frcControls-testPlans-item-response"
    }
}

Nested Schema : frcControls-additionalInformation-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  The context of the flexfields associated to the control.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• ControlId: integer (int64)
  Title: Record ID

  The unique identifier of the descriptive flexfield for the control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ControlId":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier of the descriptive flexfield for the control.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GRC_CONTROL_S"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "description":"The context of the flexfields associated to the control.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : 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-assertions-item-response

Type: object

Show Source

• AssertionCode: string
  Maximum Length: 30

  The code for a control assertion.
• ControlId: integer (int64)
  Read Only: true

  The unique identifier of the control an assertion is related to.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ControlId":{
            "type":"integer",
            "description":"The unique identifier of the control an assertion is related to.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "AssertionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code for a control assertion.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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-comments-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the comment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the comment was created.
• Id: integer
  The unique identifier of the comment on the control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UserComment: string
  Title: Comment

  Maximum Length: 2000

  The comment made on the control.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the comment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the comment on the control.",
            "nullable":false,
            "x-hints":{
                "GRC::SEQUENCE_NAME":"GRC_COMMENT_S"
            },
            "x-queryable":true
        },
        "UserComment":{
            "title":"Comment",
            "maxLength":"2000",
            "type":"string",
            "description":"The comment made on the control.",
            "nullable":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 : frcControls-perspectives-item-response

Type: object

Show Source

• ControlId: integer (int64)
  The unique identifier of the control to which a perspective is assigned.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PerspItemId: integer (int64)
  The identifier for a perspective value assigned to the control.

{
    "type":"object",
    "properties":{
        "ControlId":{
            "type":"integer",
            "description":"The unique identifier of the control to which a perspective is assigned.",
            "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"
            }
        },
        "PerspItemId":{
            "type":"integer",
            "description":"The identifier for a perspective value assigned to the control.",
            "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-relatedRisks-item-response

Type: object

Show Source

• ChildId: integer (int64)
  Read Only: true

  The identifier of the control related to a risk.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentId: integer (int64)
  Read Only: true

  The identifier of the risk related to a control.

{
    "type":"object",
    "properties":{
        "ParentId":{
            "type":"integer",
            "description":"The identifier of the risk related to a control.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChildId":{
            "type":"integer",
            "description":"The identifier of the control related to a risk.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        }
    }
}

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-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 : 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

additionalInformation

Operation: /fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}/child/additionalInformation

Parameters:

• ControlId: $request.path.ControlId

The flexfields resource is used to view or modify information added to control definitions in flexfields.

assertions

Operation: /fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}/child/assertions

Parameters:

• ControlId: $request.path.ControlId

The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control.

comments

Operation: /fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}/child/comments

Parameters:

• ControlId: $request.path.ControlId

The comments resource is used to view or modify comments written about controls.

perspectives

Operation: /fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}/child/perspectives

Parameters:

• ControlId: $request.path.ControlId

The perspectives resource is used to view perspective values assigned to controls or to modify those assignments.

relatedRisks

Operation: /fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}/child/relatedRisks

Parameters:

• ControlId: $request.path.ControlId

The related risks resource is used to view records of risks that are related to the control.

testPlans

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

Parameters:

• ControlId: $request.path.ControlId

The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective.

Back to Top

Examples

The following example shows how to update a control by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038

Example Request Payload

The following example shows the contents of the request body in JSON format:

{

"Name": "Auto Risk Control1 patch"

}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "Name": "Auto Risk Control1 patch",
    "StateCode": "EDIT",
    "Status": "ACTIVE",
    "ControlMethod": "MANUAL",
    "ControlFrequency": "DAILY",
    "AuditTestingFlag": "Y",
    "AssessmentFlag": "Y",
    "EnforcementType": "CORRECTIVE",
    "ControlAudit": "N",
    "ControlCost": null,
    "ControlId": 10038,
    "ControlType": null,
    "CreationDate": "2019-04-19T06:46:48+00:00",
    "LastUpdateDate": "2019-07-15T06:24:34.035+00:00",
    "LastUpdatedBy": "frc_wsuser",
    "ReviewedBy": "FRC_ADMIN",
    "ApprovedBy": "FRC_ADMIN",
    "ApprovedDate": "2019-04-19T06:50:58.511+00:00",
    "ReviewStartDate": null,
    "ReviewedDate": "2019-04-19T06:49:36.118+00:00",
    "RevisionDate": "2019-07-15T06:24:53.211+00:00",
    "StartDate": "2019-04-19T06:46:48+00:00",
    "TotalRevisions": 3,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038",
            "name": "frcControls",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038",
            "name": "frcControls",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_YesOrNo",
            "name": "FRCLookupsAM_YesOrNo",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_ControlEnforcementType",
            "name": "FRCLookupsAM_ControlEnforcementType",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_ControlMethod",
            "name": "FRCLookupsAM_ControlMethod",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_ControlState",
            "name": "FRCLookupsAM_ControlState",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_ControlType",
            "name": "FRCLookupsAM_ControlType",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_BusinessEntityStatus",
            "name": "FRCLookupsAM_BusinessEntityStatus",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_ControlFrequency",
            "name": "FRCLookupsAM_ControlFrequency",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/additionalInformation",
            "name": "additionalInformation",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/assertions",
            "name": "assertions",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/comments",
            "name": "comments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/perspectives",
            "name": "perspectives",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/relatedRisks",
            "name": "relatedRisks",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/testPlans",
            "name": "testPlans",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/enclosure/DetailedDescription",
            "name": "DetailedDescription",
            "kind": "other"
        }
    ]
}

Back to Top