PorticoDocs

Admin Items

Generated admin items operations.

POST/v1/admin/items/{id}/file-info/separateMake one exact file version its own title; the file keeps its facts and the title it leaves keeps its other versions and personal statelibrary
Audience
Clients · Native API
Authorization
API key or personal access token with the library scope, or a signed-in session
OpenAPI operation ID
separate_item_file_info
Max body
4 KiB

Parameters

NameInTypeDescription
idrequiredpathstring

Request body application/json · required

Example
{
  "fileInfo": {
    "occurrence": "string",
    "opening": "string"
  }
}
Schema
  • fileInfoobject | any | nullrequired
    • occurrencestringrequired
    • openingstringrequired

Responses

200Successapplication/json

Example
{
  "itemId": "id_8h2k4q"
}
Schema
  • itemIdstringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationmetadata_unavailablesource_changedinternaltimeoutdatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/items/{id}/file-info/separate" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileInfo":{"occurrence":"string","opening":"string"}}'
DELETE/v1/admin/items/{id}/files/{fileId}Delete one file version while keeping its title and personal statelibrary
Audience
Clients · Native API
Authorization
API key or personal access token with the library scope, or a signed-in session
OpenAPI operation ID
delete_title_version
Max body
4 KiB

Parameters

NameInTypeDescription
idrequiredpathstring
fileIdrequiredpathstring

Request body application/json · required

Example
{
  "confirmation": "string",
  "fileInfo": {
    "occurrence": "string",
    "opening": "string"
  },
  "operationId": "id_8h2k4q",
  "previewKey": "string"
}
Schema
  • confirmationstringrequired
  • fileInfoobject
    • occurrencestringrequired
    • openingstringrequired
  • operationIdstringrequired
  • previewKeystringrequired

Responses

200Successapplication/json

Example
{
  "bytesDeleted": 0,
  "failed": 0,
  "filesRetained": true,
  "receipts": [
    {
      "bytes": 0,
      "code": "string",
      "filesDeleted": 0,
      "filesKept": 0,
      "itemId": "id_8h2k4q",
      "removed": true,
      "title": "Fargo"
    }
  ],
  "removed": 0,
  "revision": 0
}
Schema
  • bytesDeletedintegerrequired
  • failedintegerrequired
  • filesRetainedbooleanrequired
  • receiptsarray of objectrequired
    • bytesintegerrequired
    • codestring
    • filesDeletedintegerrequired
    • filesKeptintegerrequired
    • itemIdstringrequired
    • removedbooleanrequired
    • titlestringrequired
  • removedintegerrequired
  • revisionintegerrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestrevision_mismatchconfirmation_mismatchadministration_unavailablestale_continuationmetadata_unavailableinternaltimeoutdatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/admin/items/{id}/files/{fileId}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"confirmation":"string","fileInfo":{"occurrence":"string","opening":"string"},"operationId":"id_8h2k4q","previewKey":"string"}'
POST/v1/admin/items/{id}/files/{fileId}/delete/previewDelete one file version while keeping its title and personal statelibrary
Audience
Clients · Native API
Authorization
API key or personal access token with the library scope, or a signed-in session
OpenAPI operation ID
preview_delete_title_version
Max body
4 KiB

Parameters

NameInTypeDescription
idrequiredpathstring
fileIdrequiredpathstring

Request body application/json

Example
{
  "fileInfo": {
    "occurrence": "string",
    "opening": "string"
  }
}
Schema
  • fileInfoobject
    • occurrencestringrequired
    • openingstringrequired

Responses

200Successapplication/json

Example
{
  "assetId": "id_8h2k4q",
  "blocked": [
    "string"
  ],
  "confirmation": "string",
  "confirmationKind": "string",
  "previewKey": "string",
  "revision": 0,
  "targets": [
    {
      "allowMediaDeletion": true,
      "bytes": 0,
      "dependents": [
        {
          "count": 0,
          "description": "string",
          "kind": "string"
        }
      ],
      "files": [
        {
          "assetId": "id_8h2k4q",
          "bytes": 0,
          "path": "string",
          "present": true,
          "shared": true
        }
      ],
      "itemId": "id_8h2k4q",
      "kind": "string",
      "libraryId": "id_8h2k4q",
      "libraryName": "Fargo",
      "title": "Fargo",
      "titles": 0
    }
  ],
  "totalBytes": 0,
  "totalBytesText": "string",
  "totalFiles": 0
}
Schema
  • assetIdstringrequired
  • blockedarray of stringrequired
  • confirmationstringrequired
  • confirmationKindstringrequired
  • previewKeystringrequired
  • revisionintegerrequired
  • targetsarray of objectrequired
    • allowMediaDeletionbooleanrequired
    • bytesintegerrequired
    • dependentsarray of objectrequired
      • countintegerrequired
      • descriptionstringrequired
      • kindstringrequired
    • filesarray of objectrequired
      • assetIdstringrequired
      • bytesintegerrequired
      • pathstringrequired
      • presentbooleanrequired
      • sharedbooleanrequired
    • itemIdstringrequired
    • kindstringrequired
    • libraryIdstringrequired
    • libraryNamestringrequired
    • titlestringrequired
    • titlesintegerrequired
  • totalBytesintegerrequired
  • totalBytesTextstringrequired
  • totalFilesintegerrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestrevision_mismatchconfirmation_mismatchadministration_unavailablestale_continuationmetadata_unavailableinternaltimeoutdatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/items/{id}/files/{fileId}/delete/preview" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileInfo":{"occurrence":"string","opening":"string"}}'