Pre-General Availability: 2022-08-18. This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Jump to

• Request
• Response

Update the Project resource identified by the id

put

/20211130/projects/{projectId}

Updates the Project

Request

Path Parameters

• projectId: string
  Project OCID

Header Parameters

• if-match(optional): 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.

Body ()

The information to be updated.

Root Schema : UpdateProjectDetails

Type: object

The Project resource information to be updated.

Show Source

• configuration(optional): object ProjectLimits
  Project level limits
• definedTags(optional): object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
• description(optional): string
  Minimum Length: 6

  Maximum Length: 2048

  Description of the Project resource
• displayName(optional): string
  Minimum Length: 1

  Maximum Length: 255

  Name of the Project resource
• freeformTags(optional): object freeformTags
  Additional Properties Allowed: additionalProperties

  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
• systemTags(optional): object systemTags
  Additional Properties Allowed: additionalProperties

  Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`

{
    "description":"The Project resource information to be updated.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Name of the Project resource",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "description":{
            "description":"Description of the Project resource",
            "type":"string",
            "minLength":6,
            "maxLength":2048
        },
        "configuration":{
            "$ref":"#/definitions/ProjectLimits"
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope.\nExists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
                }
            }
        },
        "systemTags":{
            "description":"Usage of system tag keys. These predefined keys are scoped to namespaces.\nExample: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
                }
            }
        }
    }
}

Nested Schema : ProjectLimits

Type: object

Project level limits

Show Source

• maxConcurrentQueries(optional): integer
  Minimum Value: 1

  Maximum Value: 15

  Default Value: 5

  Max no. of concurrent queries running per project
• maxDataReadPerQueryInGBs(optional): integer
  Minimum Value: 1

  Maximum Value: 1024

  Default Value: 10

  Max data read (in GB) per query. Default = 10GB
• maxOcpuTimeTakenPerQueryInSeconds(optional): integer(int64)
  Minimum Value: 60

  Maximum Value: 43200

  Default Value: 7200

  Max OCPU time (in seconds) per query run after which the query will be aborted. Aborted queries will not be billed. Default = 2 hr (7200 sec)
• maxTimeTakenPerQueryInSeconds(optional): integer
  Minimum Value: 60

  Maximum Value: 43200

  Default Value: 7200

  Max time (in seconds) per query run after which the query will be aborted. Aborted queries will not be billed. Default = 2 hr (7200 sec)

{
    "description":"Project level limits",
    "type":"object",
    "properties":{
        "maxConcurrentQueries":{
            "description":"Max no. of concurrent queries running per project",
            "type":"integer",
            "default":5,
            "minimum":1,
            "maximum":15
        },
        "maxTimeTakenPerQueryInSeconds":{
            "description":"Max time (in seconds) per query run after which the query will be aborted. Aborted queries will not be billed. Default = 2 hr (7200 sec)",
            "type":"integer",
            "default":7200,
            "minimum":60,
            "maximum":43200
        },
        "maxOcpuTimeTakenPerQueryInSeconds":{
            "description":"Max OCPU time (in seconds) per query run after which the query will be aborted. Aborted queries will not be billed. Default = 2 hr (7200 sec)",
            "type":"integer",
            "format":"int64",
            "default":7200,
            "minimum":60,
            "maximum":43200
        },
        "maxDataReadPerQueryInGBs":{
            "description":"Max data read (in GB) per query. Default = 10GB",
            "type":"integer",
            "default":10,
            "minimum":1,
            "maximum":1024
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope.\nExists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`

{
    "description":"Usage of system tag keys. These predefined keys are scoped to namespaces.\nExample: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
        }
    }
}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer and boolean types are supported.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
    }
}

Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer and boolean types are supported.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The Project resource is 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.

Body ()

Root Schema : Project

Type: object

Project resource.

Show Source

• compartmentId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment
• configuration: object ProjectLimits
  Project level limits
• dataCatalogId(optional): string
  Data Catalog OCID
• definedTags(optional): object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
• description(optional): string
  Minimum Length: 6

  Maximum Length: 2048

  Description of the Project resource
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  Name of the Project resource
• freeformTags(optional): object freeformTags
  Additional Properties Allowed: additionalProperties

  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
• id: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Project resource
• jdbcConnection(optional): string
  URL for jdbc connection

  Example: jdbc://oracle:default-connection
• lifecycleState: string
  Allowed Values: [ "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" ]

  The current state of the Project resource.
• systemTags(optional): object systemTags
  Additional Properties Allowed: additionalProperties

  Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
• timeCreated: string(date-time)
  The time the Project instance was created. An RFC3339 formatted datetime string

  Example: 2019-03-29T09:36:42.000Z
• timeUpdated(optional): string(date-time)
  The time the Project instance was updated. An RFC3339 formatted datetime string

  Example: 2019-03-29T09:36:42.000Z

{
    "description":"Project resource.",
    "x-obmcs-splat":{
        "resourceKind":"query-project",
        "adLocality":"regional",
        "ocidEntityType":"queryserviceproject",
        "activeLifecycleStates":[
            "active"
        ],
        "deletedLifecycleStates":[
            "deleted"
        ],
        "getOperationId":"GetProject",
        "listResourcesOperationId":"ListProjects"
    },
    "type":"object",
    "required":[
        "id",
        "compartmentId",
        "displayName",
        "lifecycleState",
        "timeCreated",
        "configuration"
    ],
    "properties":{
        "id":{
            "description":"The OCID of the Project resource",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "description":{
            "description":"Description of the Project resource",
            "type":"string",
            "minLength":6,
            "maxLength":2048
        },
        "compartmentId":{
            "description":"The OCID of the compartment",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "displayName":{
            "description":"Name of the Project resource",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "lifecycleState":{
            "description":"The current state of the Project resource.",
            "type":"string",
            "enum":[
                "CREATING",
                "ACTIVE",
                "UPDATING",
                "DELETING",
                "DELETED",
                "FAILED"
            ]
        },
        "timeCreated":{
            "description":"The time the Project instance was created. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time",
            "example":"2019-03-29T09:36:42.000Z"
        },
        "timeUpdated":{
            "description":"The time the Project instance was updated. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time",
            "example":"2019-03-29T09:36:42.000Z"
        },
        "dataCatalogId":{
            "description":"Data Catalog OCID",
            "type":"string"
        },
        "jdbcConnection":{
            "description":"URL for jdbc connection",
            "type":"string",
            "example":"jdbc://oracle:default-connection"
        },
        "configuration":{
            "$ref":"#/definitions/ProjectLimits"
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope.\nExists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
                }
            }
        },
        "systemTags":{
            "description":"Usage of system tag keys. These predefined keys are scoped to namespaces.\nExample: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
                }
            }
        }
    }
}

Nested Schema : ProjectLimits

Type: object

Project level limits

Show Source

• maxConcurrentQueries(optional): integer
  Minimum Value: 1

  Maximum Value: 15

  Default Value: 5

  Max no. of concurrent queries running per project
• maxDataReadPerQueryInGBs(optional): integer
  Minimum Value: 1

  Maximum Value: 1024

  Default Value: 10

  Max data read (in GB) per query. Default = 10GB
• maxOcpuTimeTakenPerQueryInSeconds(optional): integer(int64)
  Minimum Value: 60

  Maximum Value: 43200

  Default Value: 7200

  Max OCPU time (in seconds) per query run after which the query will be aborted. Aborted queries will not be billed. Default = 2 hr (7200 sec)
• maxTimeTakenPerQueryInSeconds(optional): integer
  Minimum Value: 60

  Maximum Value: 43200

  Default Value: 7200

  Max time (in seconds) per query run after which the query will be aborted. Aborted queries will not be billed. Default = 2 hr (7200 sec)

{
    "description":"Project level limits",
    "type":"object",
    "properties":{
        "maxConcurrentQueries":{
            "description":"Max no. of concurrent queries running per project",
            "type":"integer",
            "default":5,
            "minimum":1,
            "maximum":15
        },
        "maxTimeTakenPerQueryInSeconds":{
            "description":"Max time (in seconds) per query run after which the query will be aborted. Aborted queries will not be billed. Default = 2 hr (7200 sec)",
            "type":"integer",
            "default":7200,
            "minimum":60,
            "maximum":43200
        },
        "maxOcpuTimeTakenPerQueryInSeconds":{
            "description":"Max OCPU time (in seconds) per query run after which the query will be aborted. Aborted queries will not be billed. Default = 2 hr (7200 sec)",
            "type":"integer",
            "format":"int64",
            "default":7200,
            "minimum":60,
            "maximum":43200
        },
        "maxDataReadPerQueryInGBs":{
            "description":"Max data read (in GB) per query. Default = 10GB",
            "type":"integer",
            "default":10,
            "minimum":1,
            "maximum":1024
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope.\nExists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`

{
    "description":"Usage of system tag keys. These predefined keys are scoped to namespaces.\nExample: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
        }
    }
}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer and boolean types are supported.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
    }
}

Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer and boolean types are supported.

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.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

Back to Top