Jump to

• Request
• Response
• Examples

Retrieve a Project Business Policy

get

/ic/api/integration/v1/projects/{projectId}/mcp/policies/business/{id}

Retrieves a project business policy, including its scope and configuration.

Request

Path Parameters

• id(required): string
  Resource code, optionally followed by |01.00.0000. Omitted versions default to 01.00.0000; other versions are rejected.

  Example:

  BUSINESS_POLICY

• projectId(required): string
  Project identifier

  Example:

  MCP_PROJECT

Query Parameters

• expand: string
  Accepted but ignored for this single-policy operation; the policy details are returned independently of this parameter.
• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

  Example:

  example-instance

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.model+json;type=singular
• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

MCP policy details, including scope and type-specific configuration.

Show Source

• code: string
  Resource code.
• config: object config
  Additional Properties Allowed: true

  Policy-type-specific configuration. Its required fields depend on the policy type.
• created: string (date-time)
  Time the resource was created.
• createdBy: string
  User who created the resource.
• description: string
  Description of the resource.
• iconclass: string
  Icon CSS class for displaying this policy or template.
• id: string
  Resource identifier.
• lastUpdated: string (date-time)
  Time the resource was last updated.
• lastUpdatedBy: string
  User who last updated the resource.
• links: array links
  Links to related resources.
• name: string
  Display name of the resource.
• policyType: string
  Policy type identifier.
• processingTime: number (float)
  Server-reported processing time.
• projectCode: string
  Optional project code accepted on create or update. It must match the project in the request path; if omitted, the current project is used.
• projectId: string
  Project identifier.
• projectName: string
  Project display name.
• scope: scope
  Resource scope to which the MCP policy applies.
• status: string
  Allowed Values: [ "INPROGRESS", "CONFIGURED" ]

  Current resource state.
• version: string
  Resource version. The release accepts only 01.00.0000 on writes and uses it when the version is omitted.

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_Link"
            },
            "description":"Links to related resources."
        },
        "processingTime":{
            "type":"number",
            "format":"float",
            "description":"Server-reported processing time."
        },
        "id":{
            "type":"string",
            "description":"Resource identifier."
        },
        "projectId":{
            "type":"string",
            "description":"Project identifier."
        },
        "projectName":{
            "type":"string",
            "description":"Project display name."
        },
        "name":{
            "type":"string",
            "description":"Display name of the resource."
        },
        "code":{
            "type":"string",
            "description":"Resource code."
        },
        "version":{
            "type":"string",
            "description":"Resource version. The release accepts only 01.00.0000 on writes and uses it when the version is omitted."
        },
        "description":{
            "type":"string",
            "description":"Description of the resource."
        },
        "policyType":{
            "type":"string",
            "description":"Policy type identifier."
        },
        "status":{
            "type":"string",
            "enum":[
                "INPROGRESS",
                "CONFIGURED"
            ],
            "description":"Current resource state."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Time the resource was created."
        },
        "createdBy":{
            "type":"string",
            "description":"User who created the resource."
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time the resource was last updated."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"User who last updated the resource."
        },
        "scope":{
            "description":"Resource scope to which the MCP policy applies.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/PolicyScopeRs"
                }
            ]
        },
        "config":{
            "type":"object",
            "additionalProperties":true,
            "description":"Policy-type-specific configuration. Its required fields depend on the policy type."
        },
        "iconclass":{
            "type":"string",
            "description":"Icon CSS class for displaying this policy or template."
        },
        "projectCode":{
            "type":"string",
            "writeOnly":true,
            "description":"Optional project code accepted on create or update. It must match the project in the request path; if omitted, the current project is used."
        }
    },
    "description":"MCP policy details, including scope and type-specific configuration."
}

Nested Schema : config

Type: object

Additional Properties Allowed: true

Policy-type-specific configuration. Its required fields depend on the policy type.

Nested Schema : links

Type: array

Links to related resources.

Show Source

• Array of: object MCP2610_Link
  A link to a related REST resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_Link"
    },
    "description":"Links to related resources."
}

Nested Schema : scope

Resource scope to which the MCP policy applies.

Match All

Resource scope to which the MCP policy applies.

Show Source

• object PolicyScopeRs
  Resource scope to which the MCP policy applies.

{
    "description":"Resource scope to which the MCP policy applies.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PolicyScopeRs"
        }
    ]
}

Nested Schema : MCP2610_Link

Type: object

A link to a related REST resource.

Show Source

• href: string
  URL of the linked resource.
• mediaType: string
  Media type of the linked resource.
• rel: string
  Relationship of the linked resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relationship of the linked resource."
        },
        "href":{
            "type":"string",
            "description":"URL of the linked resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type of the linked resource."
        }
    },
    "description":"A link to a related REST resource."
}

Nested Schema : PolicyScopeRs

Type: object

Resource scope to which the MCP policy applies.

Show Source

• code: string
  Resource code.
• level: string
  Scope level.
• version: string
  Version of the referenced resource, defaulting to 01.00.0000 where a version is used.

{
    "type":"object",
    "properties":{
        "level":{
            "type":"string",
            "description":"Scope level."
        },
        "code":{
            "type":"string",
            "description":"Resource code."
        },
        "version":{
            "type":"string",
            "description":"Version of the referenced resource, defaulting to 01.00.0000 where a version is used."
        }
    },
    "description":"Resource scope to which the MCP policy applies."
}

400 Response

Malformed parameters

401 Response

Unauthorized or insufficient design-time permissions

404 Response

Project or resource not found, or the MCP feature is not available

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve a project business policy, including its scope and configuration, by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Retrieve a Project Business Policy

curl --request GET --include \
  --url "${BASE_URL}/ic/api/integration/v1/projects/${PROJECT_ID}/mcp/policies/business/${BUSINESS_POLICY_ID}?integrationInstance=${INTEGRATION_INSTANCE}" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/json"

Back to Top