Skip to content
PalomPalomAtlas

Detail

GET
/api/v1/object/detail
curl --request GET \
  --url 'https://example.com/api/v1/object/detail?key=example&bucket=example'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
key
required
Key
string
bucket
required
Bucket
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ObjectDetail
object
key
required
Key
string
name
required
Name
string
size
required
Any of:
integer
content_type
required
Any of:
string
last_modified
required
Any of:
string format: date-time
etag
required
Any of:
string
tags
required
Tags
object
key
additional properties
string
metadata
required
Metadata
object
key
additional properties
string
document
required
Any of:
DocumentSummary
object
id
required
Id
string format: uuid
state
required
DocumentState
string
Allowed values: NORMAL PROCESSING SUCCESS ERROR
stale
required
Stale
boolean
orphan
required
Orphan
boolean
properties
required
Properties
object
key
additional properties
any
link_count
required
Link Count
integer
retention
required
Any of:
RetentionConfigModel
object
mode
required
Mode
string
Allowed values: GOVERNANCE COMPLIANCE
retain_until
required
Retain Until
string format: date-time
legal_hold
required
Legal Hold
boolean
object_lock_enabled
required
Object Lock Enabled
boolean
Example
{
  "document": {
    "state": "NORMAL"
  },
  "retention": {
    "mode": "GOVERNANCE"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}