Update Campaign
put
/access-governance/access-reviews/20250331/campaigns/{campaignId}
Updates an existing campaign. You can edit a campaign in the Draft or Scheduled state.
Request
Path Parameters
-
campaignId(required): string
Unique Campaign identifier.
Header Parameters
-
if-match: string
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
-
opc-request-id: string
The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Details for updating a campaign.
Root Schema : CreateCampaignDetails
Type:
objectThe information about new campaign.
Show Source
-
criteria:
array criteria
Maximum Number of Items:
20The criteria for the campaign. -
customReviewerId:
string
Minimum Length:
1Maximum Length:255User ID of the custom reviewer in the custom user workflow. -
description:
string
Minimum Length:
0Maximum Length:255The campaign description. -
displayName:
string
Minimum Length:
1Maximum Length:255The display name of the campaign. -
isRecurring:
boolean
Whether or not the campaign is recurring - if recurring, then the frequency and seriesRecurrences will also be provided.
-
justificationRule:
string
Allowed Values:
[ "REQUIRE_FOR_ALL", "REQUIRE_FOR_REVOKE", "OPTIONAL_FOR_ALL" ]The justification rule for the campaign. -
ownerEmail:
string
Minimum Length:
1Maximum Length:255The email of the campaign owner. -
ownerId:
string
Minimum Length:
1Maximum Length:255User ID of campaign owner. -
ownerName:
string
Minimum Length:
1Maximum Length:255The name of the campaign owner. -
ownerUsername:
string
Minimum Length:
1Maximum Length:255The username of the campaign owner. -
reviewExclusions:
array reviewExclusions
Maximum Number of Items:
20List of the review types which are excluded from campaign. -
reviewWorkflowId:
string
The review workflow ID associated with the reviewLevels.
-
scope:
string
Allowed Values:
[ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ]The scope of the campaign. -
seriesRecurrences:
string(x-obmcs-recurring-time)
Maximum Length:
255The recurrence rule which describes the schedule to run a recurring campaign. It is a RFC5545 formatted string. -
submissionType(required):
string
Allowed Values:
[ "SAVE", "SUBMIT", "SUBMIT_NOW", "EWB_IDENTITY", "EWB_AC" ]Submission type of this action. -
timeSeriesStarted:
string(date-time)
The series start date of a recurring campaign. An RFC3339 formatted datetime string.
-
timeStarted:
string(date-time)
The start date of the campaign.
-
type:
string
Allowed Values:
[ "ACCESS", "OWNERSHIP" ]The type of the campaign (access or ownership). It will help UI to identify what to read in CampaignCriteria (criteriaValue or conditions).
Nested Schema : criteria
Type:
arrayMaximum Number of Items:
20The criteria for the campaign.
Show Source
-
Array of:
object Criteria
The criteria to use as a filter.
Nested Schema : reviewExclusions
Type:
arrayMaximum Number of Items:
20List of the review types which are excluded from campaign.
Show Source
-
Array of:
string
Allowed Values:
[ "ACCOUNT", "ROLE" ]The review type of a review task.
Nested Schema : Criteria
Type:
objectThe criteria to use as a filter.
Show Source
-
conditions:
array conditions
Maximum Number of Items:
100Filter condition (these conditions have an AND binding between them). -
subCriteria:
array subCriteria
The list of values of the criteria.
-
type(required):
string
Allowed Values:
[ "ORGANIZATION", "JOB_CODE", "IDENTITY_LOCATION", "RESOURCE", "RESOURCE_LOCATION", "ENTITLEMENT", "ROLE", "DOMAIN", "COMPARTMENT", "CLOUD_PROVIDER", "POLICY", "POLICY_CREATED", "CUSTOM_ATTRIBUTE", "CUSTOM_ATTRIBUTE_VALUE", "IDENTITY_COLLECTION", "IC_CREATED", "TARGET_IDENTITY", "TARGET", "GLOBAL_IDENTITY", "AM_WORKFLOW", "NOT_REVIEWED_SINCE", "ACCESS_GUARDRAIL", "GRANTED_PERMISSION_TYPE", "TEMPORAL_TYPE" ]The type of the criteria. -
value:
array value
Maximum Number of Items:
500The list of values of the criteria (these values have an OR binding between them).
Nested Schema : conditions
Type:
arrayMaximum Number of Items:
100Filter condition (these conditions have an AND binding between them).
Show Source
-
Array of:
object Condition
The information about Condition.
Nested Schema : subCriteria
Type:
arrayThe list of values of the criteria.
Show Source
-
Array of:
object Criteria
The criteria to use as a filter.
Nested Schema : value
Type:
arrayMaximum Number of Items:
500The list of values of the criteria (these values have an OR binding between them).
Show Source
Nested Schema : Condition
Type:
objectThe information about Condition.
Show Source
-
additionalAttributes:
object additionalAttributes
Additional Properties Allowed: additionalPropertiesAdditional attributes for additional information related to the condition.
-
basicCondition(required):
object BasicCondition
The information about Condition.
-
childConditions:
object BasicConditionCollection
Collection of conditions.
-
type(required):
string
Allowed Values:
[ "IDENTITY_ATTRIBUTE", "PERMISSION", "DOES_NOT_HAVE_PERMISSION" ]The type for AG Resource.
Nested Schema : additionalAttributes
Type:
objectAdditional Properties Allowed
Show Source
Additional attributes for additional information related to the condition.
Nested Schema : BasicCondition
Type:
objectThe information about Condition.
Show Source
-
dataType:
string
Allowed Values:
[ "STRING", "NUMBER", "BOOLEAN", "DATE" ]Data type for the condition Identifier -
displayName(required):
string
Minimum Length:
1Maximum Length:255Access Guardrails Identifier -
lhs(required):
string
Minimum Length:
1Maximum Length:512Left hand side of the condition. -
operator(required):
string
Allowed Values:
[ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TILL", "FROM", "BETWEEN", "NOT_BETWEEN", "IN", "NOT_IN", "CONTAINS", "NOT_CONTAINS", "BEGINS_WITH", "NOT_BEGINS_WITH", "ENDS_WITH", "NOT_ENDS_WITH", "IS_NULL", "IS_NOT_NULL", "EQUAL_WITH_NULL" ]The operator for a access guardrail. -
rhs(required):
array rhs
Right hand side of the condition.
-
rhsUiDetails:
array rhsUiDetails
Right hand side details of the condition.
Nested Schema : BasicConditionCollection
Type:
objectCollection of conditions.
Show Source
-
items(required):
array items
List of condition.
Nested Schema : rhsUiDetails
Type:
arrayRight hand side details of the condition.
Show Source
-
Array of:
object UiDetail
Ui detail for rendering values on UI
Nested Schema : UiDetail
Type:
objectUi detail for rendering values on UI
Show Source
-
name(required):
string
Name of value
-
value(required):
string
Value
Nested Schema : items
Type:
arrayList of condition.
Show Source
-
Array of:
object BasicCondition
The information about Condition.
Response
Supported Media Types
- application/json
200 Response
The campaign was successfully updated.
Headers
-
etag: string
For optimistic concurrency control. See `if-match`.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Campaign
Type:
objectSummary of the AgcsCampaign.
Show Source
-
approvalWorkflow:
object InstanceWorkflow
The workflow of an approval process instance.
-
completionRule:
string
Allowed Values:
[ "APPROVE_ALL", "REVOKE_ALL" ]The completion rule to apply during review expiry. -
creatorId:
string
Minimum Length:
1Maximum Length:255The ID of the campaign creator. -
criteria:
array criteria
Maximum Number of Items:
20The selection criteria for the campaign. -
customReviewerId:
string
Minimum Length:
1Maximum Length:255User ID of the custom reviewer in the custom user workflow. -
customReviewerName:
string
Display name of the custom reviewer in the custom user workflow.
-
description:
string
The description of the campaign.
-
displayName(required):
string
Minimum Length:
1Maximum Length:255The campaign display name. -
frequency:
string
Allowed Values:
[ "ONE_TIME", "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY" ]The frequency of a recurring campaign. -
id(required):
string
The Unique Oracle ID (OCID) that is immutable on creation.
-
isRecurring:
boolean
Whether or not the campaign is recurring - if recurring, then the frequency and seriesRecurrences will also be provided.
-
justificationRule:
string
Allowed Values:
[ "REQUIRE_FOR_ALL", "REQUIRE_FOR_REVOKE", "OPTIONAL_FOR_ALL" ]The justification rule for the campaign. -
messages:
array messages
Maximum Number of Items:
50The list of messages. -
ownerEmail:
string
The campaign owner email.
-
ownerId:
string
Minimum Length:
1Maximum Length:255The campaign owner ID. -
ownerName:
string
The campaign owner name.
-
ownerUsername:
string
The username of campaign owner.
-
reviewExclusions:
array reviewExclusions
Maximum Number of Items:
20List of the review types which are excluded from campaign. -
reviewLevels:
array reviewLevels
Maximum Number of Items:
20The list of review level details. -
reviewProgress:
number(float)
The progress of the review.
-
reviewWorkflowId:
string
The review workflow ID associated with the reviewLevels.
-
scope:
string
Allowed Values:
[ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ]The scope of the campaign. -
selectionReview:
object SelectionReview
The selection count summary for the campaign.
-
seriesRecurrences:
string(x-obmcs-recurring-time)
Maximum Length:
255The recurrence rule which describes the schedule to run a recurring campaign. It is a RFC5545 formatted string. -
status(required):
string
Allowed Values:
[ "DRAFT", "SCHEDULED", "IN_PROGRESS", "READY_FOR_APPROVAL", "APPROVED", "TERMINATED", "SYSTEM_ABORTED" ]The current state of the AgcsCampaign. -
submissionType:
string
Allowed Values:
[ "SAVE", "SUBMIT", "SUBMIT_NOW", "EWB_IDENTITY", "EWB_AC" ]Submission type of this action. -
timeCreated(required):
string(date-time)
The time the the AgcsCampaign was created. An RFC3339 formatted datetime string.
-
timeDue:
string(date-time)
The time the the AgcsCampaign was created. An RFC3339 formatted datetime string.
-
timeLastPendingGenerated:
string(date-time)
The latest time the pending review tasks view was generated. An RFC3339 formatted datetime string.
-
timeSeriesStarted:
string(date-time)
The series start date of a recurring campaign. An RFC3339 formatted datetime string.
-
timeStarted:
string(date-time)
The time the the AgcsCampaign was created. An RFC3339 formatted datetime string.
-
type(required):
string
Allowed Values:
[ "ACCESS", "OWNERSHIP" ]The type of the campaign (access or ownership). It will help UI to identify what to read in CampaignCriteria (criteriaValue or conditions).
Nested Schema : InstanceWorkflow
Type:
objectThe workflow of an approval process instance.
Show Source
-
displayName(required):
string
Minimum Length:
1Maximum Length:100The approval workflow name. -
stages(required):
array stages
Minimum Number of Items:
1Maximum Number of Items:20The approval workflow stages.
Nested Schema : criteria
Type:
arrayMaximum Number of Items:
20The selection criteria for the campaign.
Show Source
-
Array of:
object CampaignCriteria
The criteria filter.
Nested Schema : messages
Type:
arrayMaximum Number of Items:
50The list of messages.
Show Source
-
Array of:
object Message
Information about an event.
Nested Schema : reviewExclusions
Type:
arrayMaximum Number of Items:
20List of the review types which are excluded from campaign.
Show Source
-
Array of:
string
Allowed Values:
[ "ACCOUNT", "ROLE" ]The review type of a review task.
Nested Schema : reviewLevels
Type:
arrayMaximum Number of Items:
20The list of review level details.
Show Source
-
Array of:
object ReviewLevelDetails
The details of a review level.
Nested Schema : SelectionReview
Type:
objectThe selection count summary for the campaign.
Show Source
-
accessGuardrailTally(required):
object Tally
the tally.
-
approvalWorkflowTally(required):
object Tally
the tally.
-
entitlementTally(required):
object Tally
the tally.
-
identityCollectionTally(required):
object Tally
the tally.
-
identityTally(required):
object Tally
the tally.
-
policyTally(required):
object Tally
the tally.
-
resourceTally(required):
object Tally
the tally.
-
roleTally(required):
object Tally
the tally.
-
systemTally(required):
object Tally
the tally.
Nested Schema : stages
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
20The approval workflow stages.
Show Source
-
Array of:
object InstanceWorkflowStage
The approval process instance stage.
Nested Schema : InstanceWorkflowStage
Type:
objectThe approval process instance stage.
Show Source
-
approvers(required):
array approvers
Minimum Number of Items:
1Maximum Number of Items:20The approvals required for the stage to complete. -
completedTasks:
integer(int64)
Completed review tasks.
-
id(required):
string
The stage id. Must be unique within the process.
-
operator(required):
string
Default Value:
ALLAllowed Values:[ "ANY", "ALL" ]The operator for the approval process stage. -
state:
string
Allowed Values:
[ "COMPLETED", "PENDING_APPROVAL" ]The current state of the approval stage. Only one stage will be in 'PENDING_APPROVAL' state. -
totalTasks:
integer(int64)
Total review tasks.
Nested Schema : approvers
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
20The approvals required for the stage to complete.
Show Source
-
Array of:
object InstanceWorkflowApprover
The approvals required within the stage.
Nested Schema : InstanceWorkflowApprover
Type:
objectThe approvals required within the stage.
Show Source
-
description(required):
string
Minimum Length:
1Maximum Length:100A description of the approval. -
id(required):
string
The approver id. Must be unique within the stage.
-
isTemplateCompleted:
boolean
If the current template is completed.
-
pendingCount:
integer(int64)
Pending review tasks.
-
state:
string
Allowed Values:
[ "COMPLETED", "PENDING_APPROVAL" ]The current state of the approval request for the approval type within the stage. -
templateDetails(required):
object TemplateInstance
Instance of an approval template.
Nested Schema : TemplateInstance
Type:
objectInstance of an approval template.
Show Source
-
id(required):
string
Minimum Length:
1Maximum Length:255The approval template name, must be unique. -
name:
string
Minimum Length:
1Maximum Length:255The approval template name. -
parameterValues:
array parameterValues
List of approval template parameter values.
Nested Schema : parameterValues
Type:
arrayList of approval template parameter values.
Show Source
-
Array of:
object TemplateParamTuple
Value(s) for the template parameter identified by id.
Nested Schema : TemplateParamTuple
Type:
objectValue(s) for the template parameter identified by id.
Show Source
-
description:
string
Minimum Length:
1Maximum Length:255Description of the template parameter id. -
id(required):
string
Minimum Length:
1Maximum Length:255The template parameter id. Unique within the template parameter list.
Nested Schema : CampaignCriteria
Type:
objectThe criteria filter.
Show Source
-
conditions:
array conditions
Maximum Number of Items:
100Filter condition (these conditions have an AND binding between them). -
criteriaValue:
array criteriaValue
Maximum Number of Items:
500The list of values of the criteria. -
subCriteria:
array subCriteria
Maximum Number of Items:
500The list of values of the Campaign criteria -
type(required):
string
Allowed Values:
[ "ORGANIZATION", "JOB_CODE", "IDENTITY_LOCATION", "RESOURCE", "RESOURCE_LOCATION", "ENTITLEMENT", "ROLE", "DOMAIN", "COMPARTMENT", "CLOUD_PROVIDER", "POLICY", "POLICY_CREATED", "CUSTOM_ATTRIBUTE", "CUSTOM_ATTRIBUTE_VALUE", "IDENTITY_COLLECTION", "IC_CREATED", "TARGET_IDENTITY", "TARGET", "GLOBAL_IDENTITY", "AM_WORKFLOW", "NOT_REVIEWED_SINCE", "ACCESS_GUARDRAIL", "GRANTED_PERMISSION_TYPE", "TEMPORAL_TYPE" ]The type of the criteria.
Nested Schema : conditions
Type:
arrayMaximum Number of Items:
100Filter condition (these conditions have an AND binding between them).
Show Source
-
Array of:
object Condition
The information about Condition.
Nested Schema : criteriaValue
Type:
arrayMaximum Number of Items:
500The list of values of the criteria.
Show Source
-
Array of:
object CriteriaValue
The criteria value.
Nested Schema : subCriteria
Type:
arrayMaximum Number of Items:
500The list of values of the Campaign criteria
Show Source
-
Array of:
object CampaignCriteria
The criteria filter.
Nested Schema : Condition
Type:
objectThe information about Condition.
Show Source
-
additionalAttributes:
object additionalAttributes
Additional Properties Allowed: additionalPropertiesAdditional attributes for additional information related to the condition.
-
basicCondition(required):
object BasicCondition
The information about Condition.
-
childConditions:
object BasicConditionCollection
Collection of conditions.
-
type(required):
string
Allowed Values:
[ "IDENTITY_ATTRIBUTE", "PERMISSION", "DOES_NOT_HAVE_PERMISSION" ]The type for AG Resource.
Nested Schema : additionalAttributes
Type:
objectAdditional Properties Allowed
Show Source
Additional attributes for additional information related to the condition.
Nested Schema : BasicCondition
Type:
objectThe information about Condition.
Show Source
-
dataType:
string
Allowed Values:
[ "STRING", "NUMBER", "BOOLEAN", "DATE" ]Data type for the condition Identifier -
displayName(required):
string
Minimum Length:
1Maximum Length:255Access Guardrails Identifier -
lhs(required):
string
Minimum Length:
1Maximum Length:512Left hand side of the condition. -
operator(required):
string
Allowed Values:
[ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TILL", "FROM", "BETWEEN", "NOT_BETWEEN", "IN", "NOT_IN", "CONTAINS", "NOT_CONTAINS", "BEGINS_WITH", "NOT_BEGINS_WITH", "ENDS_WITH", "NOT_ENDS_WITH", "IS_NULL", "IS_NOT_NULL", "EQUAL_WITH_NULL" ]The operator for a access guardrail. -
rhs(required):
array rhs
Right hand side of the condition.
-
rhsUiDetails:
array rhsUiDetails
Right hand side details of the condition.
Nested Schema : BasicConditionCollection
Type:
objectCollection of conditions.
Show Source
-
items(required):
array items
List of condition.
Nested Schema : rhsUiDetails
Type:
arrayRight hand side details of the condition.
Show Source
-
Array of:
object UiDetail
Ui detail for rendering values on UI
Nested Schema : UiDetail
Type:
objectUi detail for rendering values on UI
Show Source
-
name(required):
string
Name of value
-
value(required):
string
Value
Nested Schema : items
Type:
arrayList of condition.
Show Source
-
Array of:
object BasicCondition
The information about Condition.
Nested Schema : CriteriaValue
Type:
objectThe criteria value.
Show Source
-
id:
string
The ID of the value.
-
name(required):
string
The name of the value.
-
subCriteria:
array subCriteria
Maximum Number of Items:
500The list of values of the Campaign criteria.
Nested Schema : subCriteria
Type:
arrayMaximum Number of Items:
500The list of values of the Campaign criteria.
Show Source
-
Array of:
object CampaignCriteria
The criteria filter.
Nested Schema : Message
Type:
objectInformation about an event.
Show Source
-
code:
string
The message code.
-
dateCreated:
string
The unix timestamp of when the message was created.
-
message:
string
The message.
Nested Schema : ReviewLevelDetails
Type:
objectThe details of a review level.
Show Source
-
durationDays:
integer
Minimum Value:
1Maximum Value:30The duration days for the review level. -
level(required):
integer
The level for this review.
-
notificationRecipient:
string
Allowed Values:
[ "REVIEWER", "REVIEWER_AND_MANAGER" ]The first notification recipient. -
reminderFrequencyDays:
integer
Minimum Value:
0Maximum Value:29the reminder frequency in days. -
reminderRecipient:
string
Allowed Values:
[ "REVIEWER", "REVIEWER_AND_MANAGER" ]The reminder notification recipient. -
reviewerAttributes:
array reviewerAttributes
Maximum Number of Items:
20The list of reviewer attributes (only when reviewerType is CUSTOM_OWNER or CLOUD_REVIEWER). -
reviewerType:
string
Allowed Values:
[ "CUSTOM_OWNER", "OWNER", "USER", "USER_MANAGER", "CLOUD_REVIEWER", "APPROVAL_SYSTEM", "REQUESTOR", "BENEFICIARY", "BENEFICIARY_MANAGER", "CUSTOM_USER", "GROUP", "MANAGER_CHAIN", "SYSTEM", "NO_APPROVAL" ]The reviewer type for the level.
Nested Schema : reviewerAttributes
Type:
arrayMaximum Number of Items:
20The list of reviewer attributes (only when reviewerType is CUSTOM_OWNER or CLOUD_REVIEWER).
Show Source
-
Array of:
object ReviewerAttribute
The attributes of the reviewer.
Nested Schema : ReviewerAttribute
Type:
objectThe attributes of the reviewer.
Show Source
-
reviewerEmail:
string
The email of the reviewer.
-
reviewerId:
string
The ID of the reviewer.
-
reviewerIdType:
string
Allowed Values:
[ "USER" ]The type of the ID. -
reviewerName:
string
The name of the reviewer.
-
type(required):
string
Allowed Values:
[ "APPLICATION_OWNER", "ROLE_OWNER", "ENTITLEMENT_OWNER", "CLOUD_RESOURCE_OWNER" ]The type of reviewer.
Nested Schema : Tally
Type:
objectthe tally.
Show Source
-
matchedCount(required):
integer
The count of items that matched the criteria.
-
totalCount(required):
integer
The total number of items.
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
objectError Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
objectError Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
objectError Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
409 Response
Conflict
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
objectError Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
412 Response
Precondition failed
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
objectError Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
objectError Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
objectError Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
Default Response
Unknown Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
objectError Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
Examples
The following example shows how to update a campaign. In this example, we are updating a Draft campaign.
Note:
To update the campaign, your campaign must either be in the Scheduled or Draft state.cURL Request Example
curl -i -X POST \
-H "Authorization:Bearer <your-access-token>" \
-H "Content-Type:application/json" \
-d \
'{
"displayName": "HRMS_Annual_Access_Review",
"description": "HRMS_Annual_Access_Review",
"type": "ACCESS",
"criteria": [
{
"type": "CUSTOM_ATTRIBUTE",
"value": [
"organization.displayName"
],
"subCriteria": [
{
"type": "CUSTOM_ATTRIBUTE_VALUE",
"value": ["HRMS_Review_Org", "SalesOps"]
}
]
}
],
"ownerId": "globalId.8d51efbf-abxx-4f09-aexx-7bcc0f9de5be.18.a84836862exx58ba29e9002afd63a7fb",
"reviewWorkflowId": "Guid_5b0bcda9-30xx-4cb3-b7xx-14a7a99fb2de",
"justificationRule": "REQUIRE_FOR_ALL",
"scope": "AG",
"submissionType": "SUBMIT_NOW",
"isRecurring": false,
"isAccountReviewAllowed": true
}
' \
'<${service-instance-url}/access-governance/access-reviews/20250331/campaigns/${campaignId}>'
Example Request Payload
POST ${service-instance-url}/access-governance/access-reviews/20250331/campaigns/${campaignId}{
"displayName": "HRMS_Annual_Access_Review",
"description": "HRMS_Annual_Access_Review",
"type": "ACCESS",
"criteria": [
{
"type": "CUSTOM_ATTRIBUTE",
"value": [
"organization.displayName"
],
"subCriteria": [
{
"type": "CUSTOM_ATTRIBUTE_VALUE",
"value": ["HRMS_Review_Org", "SalesOps"]
}
]
}
],
"ownerId": "globalId.8d51efbf-abxx-4f09-aexx-7bcc0f9de5be.18.a84836862exx58ba29e9002afd63a7fb",
"reviewWorkflowId": "Guid_5b0bcda9-30xx-4cb3-b7xx-14a7a99fb2de",
"justificationRule": "REQUIRE_FOR_ALL",
"scope": "AG",
"submissionType": "SUBMIT_NOW",
"isRecurring": false,
"isAccountReviewAllowed": true
}
Example of the Response Code
It may take a few seconds to create a campaign. Do not try to abort the request.
You'll receive 200 OK response along with the following response body:
{
"id": "ocid1.agcscampaign.oc1.iad.amaxxxxxebkbezqa6n4vgm5ipxuixx27swzs5cpjsewecxpgqhl2ryhxncuq",
"displayName": "HRMS_Annual_Access_Review",
"type": "ACCESS",
"ownerId": "globalId.8d51efbf-abxx-4f09-aexx-7bcc0f9de5be.18.a84836862exx58ba29e9002afd63a7fb",
"customReviewerId": null,
"customReviewerName": null,
"ownerName": "Jordan Patel",
"ownerUsername": null,
"ownerEmail": null,
"creatorId": "88b9690exx344653953570480031e7d0",
"reviewProgress": null,
"scope": "AG",
"status": "SCHEDULED",
"timeStarted": "2025-08-12T11:58:53.306Z",
"timeDue": "2025-08-12T11:58:53.306Z",
"timeCreated": "2025-08-12T11:58:53.546Z",
"criteria": [
{
"type": "CUSTOM_ATTRIBUTE",
"criteriaValue": [
{
"id": "organization.displayName",
"name": "Source Division",
"subCriteria": [
{
"type": "CUSTOM_ATTRIBUTE_VALUE",
"criteriaValue": [
{
"id": null,
"name": "HRMS_Review_Org",
"subCriteria": null
},
{
"id": null,
"name": "SalesOps",
"subCriteria": null
}
],
"conditions": null,
"subCriteria": null
}
]
}
],
"conditions": null,
"subCriteria": null
}
],
"reviewWorkflowId": "Guid_5b0bcda9-30xx-4cb3-b7xx-14a7a99fb2de",
"reviewLevels": [],
"approvalWorkflow": null,
"selectionReview": null,
"completionRule": null,
"justificationRule": "REQUIRE_FOR_ALL",
"description": "HRMS_Annual_Access_Review",
"isRecurring": false,
"timeSeriesStarted": null,
"frequency": "ONE_TIME",
"seriesRecurrences": null,
"messages": null,
"submissionType": null,
"isAccountReviewAllowed": null,
"timeLastPendingGenerated": null
}