REST API for Oracle Fusion Cloud Enterprise Data Management

Update enabled flag of a policy

post

/epm/rest/v1/policies/{policyId}/updateEnabledFlag

Request

Supported Media Types

application/json

Path Parameters

policyId(required): string(uuid)

Specifies whether the policy should be enabled or disabled.

Root Schema : Parameter to enable or disable a policy

Type: object

Show Source

enabled(required): boolean

Allowed Values: [ true, false ]

Specfies whether the policy should be enabled or disabled

{
    "type":"object",
    "required":[
        "enabled"
    ],
    "properties":{
        "enabled":{
            "type":"boolean",
            "description":"Specfies whether the policy should be enabled or disabled",
            "enum":[
                true,
                false
            ]
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Policy's enabled flag updated successfully

Root Schema : Policy

Type: object

Show Source

allowAllActions: boolean
allowAllRequestTypes: boolean
allowedActions: array allowedActions

Unique Items Required: true
application: object IdNameDescription
configuredProperties: array configuredProperties

Unique Items Required: true
createdBy: string
createdByUser: object User
description: string
dimension: object IdNameDescription
enabled: boolean
expression: object JsonNode
hierarchySet: object IdNameDescription
id: string(uuid)
invitees: array invitees
inviteeSummary: array inviteeSummary
links: array links
modifiedBy: string
modifiedByUser: object User
name: string
nodeType: object IdNameDescription
notifyOnStatusesChanged: array notifyOnStatusesChanged

Unique Items Required: true
policyLevel: string

Allowed Values: [ "APPLICATION", "NODE_TYPE", "HIERARCHY_SET", "DIMENSION" ]
policyType: string

Allowed Values: [ "APPROVAL", "NOTIFY", "COMMIT" ]
propertyFilterConfigurationType: string

Allowed Values: [ "ALL", "NONE", "INCLUDE", "EXCLUDE" ]
requestTypes: array requestTypes

Unique Items Required: true
timeCreated: integer(int64)
timeModified: integer(int64)
valid: boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "policyType":{
            "type":"string",
            "enum":[
                "APPROVAL",
                "NOTIFY",
                "COMMIT"
            ]
        },
        "policyLevel":{
            "type":"string",
            "enum":[
                "APPLICATION",
                "NODE_TYPE",
                "HIERARCHY_SET",
                "DIMENSION"
            ]
        },
        "application":{
            "$ref":"#/definitions/IdNameDescription"
        },
        "dimension":{
            "$ref":"#/definitions/IdNameDescription"
        },
        "hierarchySet":{
            "$ref":"#/definitions/IdNameDescription"
        },
        "nodeType":{
            "$ref":"#/definitions/IdNameDescription"
        },
        "createdBy":{
            "type":"string"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "modifiedBy":{
            "type":"string"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        },
        "enabled":{
            "type":"boolean"
        },
        "valid":{
            "type":"boolean"
        },
        "inviteeSummary":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdNameDescription"
            }
        },
        "notifyOnStatusesChanged":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "DRAFT",
                    "IN_FLIGHT",
                    "PULLED_BACK",
                    "PUSHED_BACK",
                    "COMPLETED",
                    "REJECTED",
                    "WITHDRAWN",
                    "RECALLED",
                    "BLOCKED",
                    "CONSOLIDATED",
                    "FUTURE_DATED"
                ]
            }
        },
        "allowAllActions":{
            "type":"boolean"
        },
        "allowedActions":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "DELETE_NODE",
                    "ADD_NODE",
                    "REMOVE_NODE",
                    "INSERT_NODE",
                    "MOVE_NODE",
                    "RENAME_NODE",
                    "UPDATE_NODE_PROP",
                    "UPDATE_REL_PROP",
                    "UPDATE_DESCRIPTION",
                    "REORDER_NODE",
                    "CLEAR_PROP",
                    "RESET_PRIMARY_LOCATION"
                ]
            }
        },
        "expression":{
            "$ref":"#/definitions/JsonNode"
        },
        "propertyFilterConfigurationType":{
            "type":"string",
            "enum":[
                "ALL",
                "NONE",
                "INCLUDE",
                "EXCLUDE"
            ]
        },
        "configuredProperties":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "requestTypes":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "DEFINED",
                    "INSTRUCTIVE",
                    "INTERACTIVE",
                    "MEMBERSHIP",
                    "NOTIFICATION",
                    "REMEDIATION",
                    "SUBSCRIPTION",
                    "CONSOLIDATION",
                    "IMPORT",
                    "LOAD"
                ]
            }
        },
        "allowAllRequestTypes":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "invitees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Invitee"
            }
        },
        "createdByUser":{
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/User"
        }
    }
}

Nested Schema : allowedActions

Type: array

Unique Items Required: true

Show Source

Array of: string

Allowed Values: [ "DELETE_NODE", "ADD_NODE", "REMOVE_NODE", "INSERT_NODE", "MOVE_NODE", "RENAME_NODE", "UPDATE_NODE_PROP", "UPDATE_REL_PROP", "UPDATE_DESCRIPTION", "REORDER_NODE", "CLEAR_PROP", "RESET_PRIMARY_LOCATION" ]

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "DELETE_NODE",
            "ADD_NODE",
            "REMOVE_NODE",
            "INSERT_NODE",
            "MOVE_NODE",
            "RENAME_NODE",
            "UPDATE_NODE_PROP",
            "UPDATE_REL_PROP",
            "UPDATE_DESCRIPTION",
            "REORDER_NODE",
            "CLEAR_PROP",
            "RESET_PRIMARY_LOCATION"
        ]
    }
}

Nested Schema : IdNameDescription

Type: object

Show Source

description: string
id: string(uuid)
name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : configuredProperties

Type: array

Unique Items Required: true

Show Source

Array of: object IdNameLink

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/IdNameLink"
    }
}

Nested Schema : User

Type: object

Show Source

artifactAssignments: array artifactAssignments
associatedRoles: array associatedRoles
dataManagerOnAny: boolean
emailAddresses: array emailAddresses
epmIdleSessionTimeout: integer(int32)
firstName: string
fullName: string
grantPermission: string

Allowed Values: [ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
homePageLayoutName: string
id: string(uuid)
lastName: string
links: array links
nameInitials: string
preferences: object Preferences
ssoToken: string
userName: string
userServiceAdministrator: boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "userName":{
            "type":"string"
        },
        "fullName":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "ssoToken":{
            "type":"string"
        },
        "emailAddresses":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "associatedRoles":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "preferences":{
            "$ref":"#/definitions/Preferences"
        },
        "nameInitials":{
            "type":"string"
        },
        "grantPermission":{
            "type":"string",
            "enum":[
                "OWNER",
                "DATAMANAGER",
                "PARTICIPANT",
                "APPROVER",
                "NOTIFIED",
                "COMMITTER",
                "NONE",
                "METADATAMANAGER"
            ]
        },
        "dataManagerOnAny":{
            "type":"boolean"
        },
        "userServiceAdministrator":{
            "type":"boolean"
        },
        "epmIdleSessionTimeout":{
            "type":"integer",
            "format":"int32"
        },
        "homePageLayoutName":{
            "type":"string"
        },
        "artifactAssignments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ArtifactAssignment"
            }
        }
    }
}

Nested Schema : JsonNode

Type: object

Nested Schema : invitees

Type: array

Show Source

Array of: object Invitee

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Invitee"
    }
}

Nested Schema : inviteeSummary

Type: array

Show Source

Array of: object IdNameDescription

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/IdNameDescription"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : notifyOnStatusesChanged

Type: array

Unique Items Required: true

Show Source

Array of: string

Allowed Values: [ "DRAFT", "IN_FLIGHT", "PULLED_BACK", "PUSHED_BACK", "COMPLETED", "REJECTED", "WITHDRAWN", "RECALLED", "BLOCKED", "CONSOLIDATED", "FUTURE_DATED" ]

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "DRAFT",
            "IN_FLIGHT",
            "PULLED_BACK",
            "PUSHED_BACK",
            "COMPLETED",
            "REJECTED",
            "WITHDRAWN",
            "RECALLED",
            "BLOCKED",
            "CONSOLIDATED",
            "FUTURE_DATED"
        ]
    }
}

Nested Schema : requestTypes

Type: array

Unique Items Required: true

Show Source

Array of: string

Allowed Values: [ "DEFINED", "INSTRUCTIVE", "INTERACTIVE", "MEMBERSHIP", "NOTIFICATION", "REMEDIATION", "SUBSCRIPTION", "CONSOLIDATION", "IMPORT", "LOAD" ]

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "DEFINED",
            "INSTRUCTIVE",
            "INTERACTIVE",
            "MEMBERSHIP",
            "NOTIFICATION",
            "REMEDIATION",
            "SUBSCRIPTION",
            "CONSOLIDATION",
            "IMPORT",
            "LOAD"
        ]
    }
}

Nested Schema : IdNameLink

Type: object

Show Source

description: string

Read Only: true
id: string(uuid)
links: array links
name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : artifactAssignments

Type: array

Show Source

Array of: object ArtifactAssignment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ArtifactAssignment"
    }
}

Nested Schema : associatedRoles

Type: array

Show Source

Array of: object Role

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role"
    }
}

Nested Schema : emailAddresses

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Preferences

Type: object

Show Source

actAsThisRole: string

Allowed Values: [ "USER", "SERVICE_ADMINISTRATOR" ]
delegateToUserId: string(uuid)
languageTag: string
links: array links
outOfOffice: boolean
profilePictureId: string(uuid)
timeZone: object TimeZone

{
    "type":"object",
    "properties":{
        "profilePictureId":{
            "type":"string",
            "format":"uuid"
        },
        "timeZone":{
            "$ref":"#/definitions/TimeZone"
        },
        "languageTag":{
            "type":"string"
        },
        "outOfOffice":{
            "type":"boolean"
        },
        "delegateToUserId":{
            "type":"string",
            "format":"uuid"
        },
        "actAsThisRole":{
            "type":"string",
            "enum":[
                "USER",
                "SERVICE_ADMINISTRATOR"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ArtifactAssignment

Type: object

Show Source

artifact: object Artifact
sortOrder: integer(int32)
visible: boolean

{
    "type":"object",
    "properties":{
        "artifact":{
            "$ref":"#/definitions/Artifact"
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32"
        },
        "visible":{
            "type":"boolean"
        }
    }
}

Nested Schema : Artifact

Type: object

Show Source

id: string(uuid)
name: string
type: string

Allowed Values: [ "CLUSTER", "CARD" ]

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "CLUSTER",
                "CARD"
            ]
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : Role

Type: object

Show Source

id: string
name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TimeZone

Type: object

Show Source

displayName: string
dstsavings: integer(int32)
id: string
rawOffset: integer(int32)

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "rawOffset":{
            "type":"integer",
            "format":"int32"
        },
        "dstsavings":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Invitee

Type: object

Show Source

group: object Group
numberOfApprovalsRequiredPerGroup: integer(int32)

Read Only: true
order: integer(int32)

Read Only: true
user: object User

{
    "type":"object",
    "properties":{
        "user":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "group":{
            "readOnly":true,
            "$ref":"#/definitions/Group"
        },
        "order":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "numberOfApprovalsRequiredPerGroup":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        }
    }
}

Nested Schema : Group

Type: object

Show Source

associatedUsers: array associatedUsers
groupSize: integer(int32)
id: string(uuid)
links: array links
name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "associatedUsers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "groupSize":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : associatedUsers

Type: array

Show Source

Array of: object User

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/User"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

400 Response

Error in body

403 Response

Forbidden

Examples

The following example shows how to enable or disable a policy by using a POST request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X POST -H 'Content-Type: application/json' @example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/policies/322df024-a20a-4367-b7c1-348b15409189/updateEnabledFlag

Example of Request Body

The following shows an example of the request body in JSON format. The value can be either true or false.

    {
        "enabled": true
    }

Example of Response Body

The following shows an example of the response body in JSON format.

    {
        "id": "322df024-a20a-4367-b7c1-348b15409189",
        "name": "Approval",
        "description": "Approval policy for Departments",
        "policyType": "APPROVAL",
        "policyLevel": "APPLICATION",
        "application": {
            "id": "64a99b9c-a13e-4509-9513-2d086da4ff00",
            "name": "Departments",
            "description": "Departments App"
        },
        "createdBy": "Doug Cosby",
        "timeCreated": "2024-09-03T16:30:47.727Z",
        "modifiedBy": "Doug Cosby",
        "timeModified": "2024-09-27T14:05:05.570Z",
        "enabled": true,
        "valid": true,
        "inviteeSummary": [
            {
                "id": "0ec452de-1cfa-4a0e-87d0-376fffdb0351",
                "name": "Accounting",
                "description": "desc"
            },
            {
                "id": "1ba600a7-1997-4784-9163-f46510533642",
                "name": "Barry Dylan",
                "description": null
            },
            {
                "id": "f52e4517-7e07-4ea5-a75b-728ef0a54530",
                "name": "GroupA",
                "description": "desc"
            },
            {
                "id": "45b96c8a-7e8a-4e24-8279-9f2b88118e29",
                "name": "Doug Cosby",
                "description": null
            }
        ],
        "processingType": "PARALLEL",
        "allInviteesMustApprove": true,
        "numberOfApprovalsRequired": 0,
        "submitterAutoApproves": false,
        "reminderNotification": 0,
        "approvalEscalation": 0,
        "daysUntilOverdue": 0,
        "allowEnrichment": false,
        "allowSettingFutureTimeLabel": false,
        "excludeWeekendsFromReminderDays": false,
        "policyOrder": 1,
        "ownershipPropertyId": null,
        "managementHierarchyNodeSet": null,
        "fulfillmentType": null,
        "fulfillmentLevels": 0,
        "fulfillmentExpression": null,
        "allowAllActions": true,
        "allowedActions": [],
        "expression": {
            "statements": [
                {
                    "type": "return",
                    "expression": {
                        "type": "booleanLiteral",
                        "value": false
                    }
                }
            ]
        },
        "propertyFilterConfigurationType": "INCLUDE",
        "configuredProperties": [
            {
                "id": "24021227-c4d9-4190-b698-9ebfed7f8015",
                "name": "Alias",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/24021227-c4d9-4190-b698-9ebfed7f8015"
                    }
                ]
            },
            {
                "id": "fb8aad87-7c0d-4d32-b523-7f807121408a",
                "name": "Aggregation Weight",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/fb8aad87-7c0d-4d32-b523-7f807121408a"
                    }
                ]
            }
        ],
        "requestTypes": [],
        "allowAllRequestTypes": true,
        "links": [
            {
                "rel": "self",
                "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/64a99b9c-a13e-4509-9513-2d086da4ff00/policies/322df024-a20a-4367-b7c1-348b15409189"
            },
            {
                "rel": "updateEnabledFlag",
                "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/policies/322df024-a20a-4367-b7c1-348b15409189/updateEnabledFlag",
                "method": "POST"
            }
        ]
    }