Jump to

• Request
• Response

(Preview) Returns bundle publish status.

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/getBundlePublishStatus

(Preview) Returns the latest publish summary.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The key of the Workspace

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Body ()

Publish status request.

Root Schema : FetchBundlePublishStatusDetails

Type: object

Bundle publish status request.

Show Source

• path(required): string
  Minimum Length: 10

  Maximum Length: 1024

  Pattern: ^/Workspace(?:/(?!\.{1,2}(?:/|$))[^/\\\r\n]+)*/?$

  Target folder for the new bundle.

{
    "description":"Bundle publish status request.",
    "type":"object",
    "required":[
        "path"
    ],
    "properties":{
        "path":{
            "description":"Target folder for the new bundle.",
            "type":"string",
            "minLength":10,
            "maxLength":1024,
            "pattern":"^/Workspace(?:/(?!\\.{1,2}(?:/|$))[^/\\\\\\r\\n]+)*/?$"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Publish status.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : BundlePublishStatus

Type: object

Bundle publish status.

Show Source

• message: string
  Publish summary.
• publish: object BundlePublishLocation
  Resolved bundle publish location for the last publish operation.
• resources: array resources
  Published resources.
• status(required): string
  Allowed Values: [ "SUCCEEDED", "FAILED", "IN_PROGRESS", "NOT_PUBLISHED" ]

  Publish status.
• timeCompleted(required): string(date-time)
  Publish end time.
• timeStarted(required): string(date-time)
  Publish start time.

{
    "description":"Bundle publish status.\n",
    "type":"object",
    "required":[
        "status",
        "timeStarted",
        "timeCompleted"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"Publish status.",
            "enum":[
                "SUCCEEDED",
                "FAILED",
                "IN_PROGRESS",
                "NOT_PUBLISHED"
            ]
        },
        "timeStarted":{
            "type":"string",
            "description":"Publish start time.",
            "format":"date-time"
        },
        "timeCompleted":{
            "type":"string",
            "description":"Publish end time.",
            "format":"date-time"
        },
        "message":{
            "type":"string",
            "description":"Publish summary."
        },
        "publish":{
            "$ref":"#/definitions/BundlePublishLocation"
        },
        "resources":{
            "description":"Published resources.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/BundlePublishedResource"
            }
        }
    }
}

Nested Schema : BundlePublishLocation

Type: object

Resolved bundle publish location for the last publish operation.

Show Source

• overwrite: boolean
  Whether the publish operation was allowed to overwrite artifacts not owned by this bundle.
• path(required): string
  Resolved publish root used by the bundle publish operation.

{
    "description":"Resolved bundle publish location for the last publish operation.",
    "type":"object",
    "required":[
        "path"
    ],
    "properties":{
        "path":{
            "type":"string",
            "description":"Resolved publish root used by the bundle publish operation."
        },
        "overwrite":{
            "type":"boolean",
            "description":"Whether the publish operation was allowed to overwrite artifacts not owned by this bundle."
        }
    }
}

Nested Schema : resources

Type: array

Published resources.

Show Source

• Array of: object BundlePublishedResource
  Published resource.

{
    "description":"Published resources.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/BundlePublishedResource"
    }
}

Nested Schema : BundlePublishedResource

Type: object

Published resource.

Show Source

• key: string
  Resource key.
• name(required): string
  Resource name
• type(required): string
  Allowed Values: [ "JOB", "AGENTFLOW" ]

  Type of resource

{
    "description":"Published resource.",
    "type":"object",
    "required":[
        "type",
        "name"
    ],
    "properties":{
        "type":{
            "description":"Type of resource",
            "type":"string",
            "enum":[
                "JOB",
                "AGENTFLOW"
            ]
        },
        "key":{
            "description":"Resource key.",
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"Resource name"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error 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 message.

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

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error 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 message.

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

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error 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 message.

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

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error 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 message.

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

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error 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 message.

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

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error 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 message.

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

Back to Top