API docs by Redocly

Colectica Repository REST API (v1)

Download OpenAPI specification:Download

Colectica Repository REST API

Agency

Marks the repository as authoritative for the specified agency.

Required permissions: ColecticaAdministrator or ColecticaUser.

Request Body schema:
agency
required
string non-empty
name
required
string non-empty

Responses

Request samples

Content type
{
  • "agency": "string",
  • "name": "string"
}

Marks the repository as no longer authoritative for the specified agency.

Required permissions: ColecticaAdministrator or ColecticaUser.

path Parameters
agency
required
string

Responses

Comment

Adds a comment to the specified item.

Required permissions: ColecticaAdministrator or ColecticaUser.

path Parameters
agency
required
string
id
required
string <uuid>
version
required
integer <int64>
Request Body schema:
comment
required
string non-empty

Responses

Request samples

Content type
{
  • "comment": "string"
}

Gets the comments for the specified item.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets multiple comments from the repository.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
required
Array of objects (IdentifierInRequest)

Responses

Request samples

Content type
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Ddi

Returns the item serialized in DDI XML as a DDI Fragment

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

path Parameters
agency
required
string
identifier
required
string

Responses

Returns the item serialized in DDI XML as a DDI Fragment

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

path Parameters
agency
required
string
identifier
required
string
version
required
integer <int64>

Responses

Returns the item and set of all children items serialized in DDI XML as a DDI FragmentInstance

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

path Parameters
agency
required
string
identifier
required
string

Responses

Returns the item and set of all children items serialized in DDI XML as a DDI FragmentInstance

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

path Parameters
agency
required
string
identifier
required
string
version
required
integer <int64>

Responses

Returns the item serialized in JSON

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

path Parameters
agency
required
string
identifier
required
string

Responses

Returns the item serialized in JSON

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

path Parameters
agency
required
string
identifier
required
string
version
required
integer <int64>

Responses

Returns the item and set of all children items serialized in nested JSON

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

path Parameters
agency
required
string
identifier
required
string

Responses

Returns the item and set of all children items serialized in nested JSON

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

path Parameters
agency
required
string
identifier
required
string
version
required
integer <int64>

Responses

Returns the item and set of all children items serialized in nested JSON, and excludes specified item types

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Request Body schema:
agencyId
string
identifier
string <uuid>
version
integer <int64>
ignoredItemTypes
Array of strings <uuid> [ items <uuid > ]
acceptedItemTypes
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "agencyId": "string",
  • "identifier": "14d3030c-3b61-4070-b902-342f80e99364",
  • "version": 0,
  • "ignoredItemTypes": [
    ],
  • "acceptedItemTypes": [
    ]
}

Event

Store information about an event.

Required permissions: ColecticaAdministrator or ColecticaUser.

Request Body schema:
logged
string <date-time>
application
string
level
integer <int32>
number
integer <int32>
version
integer <int32>
username
string
eventData
string
itemId
string <uuid>
itemAgencyId
string
itemVersion
integer <int64>

Responses

Request samples

Content type
{
  • "logged": "2019-08-24T14:15:22Z",
  • "application": "string",
  • "level": 0,
  • "number": 0,
  • "version": 0,
  • "username": "string",
  • "eventData": "string",
  • "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
  • "itemAgencyId": "string",
  • "itemVersion": 0
}

Item

Registers the items in the repository.

Required permissions: ColecticaAdministrator or ColecticaUser.

Request Body schema:
required
Array of objects (RepositoryItem)
object (CommitOptions)

Responses

Request samples

Content type
{
  • "items": [
    ],
  • "options": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets an item from the repository.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>
version
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "tag": {
    },
  • "itemType": "1e99f8fe-923d-4544-a258-891e2461226e",
  • "agencyId": "string",
  • "version": 0,
  • "identifier": "14d3030c-3b61-4070-b902-342f80e99364",
  • "compositeId": {
    },
  • "item": "string",
  • "notes": [
    ],
  • "versionDate": "2019-08-24T14:15:22Z",
  • "versionResponsibility": "string",
  • "versionRationale": {
    },
  • "isPublished": true,
  • "isDeprecated": true,
  • "isProvisional": true,
  • "itemFormat": "7c0ca910-4d0d-426d-bc91-93c657009bd7",
  • "transactionId": 0,
  • "versionCreationType": 0
}

Gets multiple items from the repository.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
required
Array of objects (IdentifierInRequest)

Responses

Request samples

Content type
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Updates the Deprecated State of a set of items

Required permissions: ColecticaAdministrator.

Request Body schema:
required
Array of objects (IdentifierInRequest)
state
required
boolean
applyToAllVersions
boolean

Responses

Request samples

Content type
{
  • "ids": [
    ],
  • "state": true,
  • "applyToAllVersions": true
}

Delete items from the Repository

Required permissions: ColecticaAdministrator.

Request Body schema:
Array of objects (IdentifierInRequest)
Array of objects (IdentifierInRequest)
transactionIds
Array of integers <int64> [ items <int64 > ]
deleteType
integer <int32> (DeleteType)
Enum: 0 1 2

Responses

Request samples

Content type
{
  • "identifiers": [
    ],
  • "setIdentifiers": [
    ],
  • "transactionIds": [
    ],
  • "deleteType": 0
}

Response samples

Content type
application/json
{
  • "deletedCounts": {
    },
  • "referenced": {
    },
  • "referencedChildren": {
    },
  • "deleteType": 0
}

Gets the latest version of an item from the repository.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "tag": {
    },
  • "itemType": "1e99f8fe-923d-4544-a258-891e2461226e",
  • "agencyId": "string",
  • "version": 0,
  • "identifier": "14d3030c-3b61-4070-b902-342f80e99364",
  • "compositeId": {
    },
  • "item": "string",
  • "notes": [
    ],
  • "versionDate": "2019-08-24T14:15:22Z",
  • "versionResponsibility": "string",
  • "versionRationale": {
    },
  • "isPublished": true,
  • "isDeprecated": true,
  • "isProvisional": true,
  • "itemFormat": "7c0ca910-4d0d-426d-bc91-93c657009bd7",
  • "transactionId": 0,
  • "versionCreationType": 0
}

Gets a list of the latest versions of undeserialized items from the repository. To retrieve deserialized

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
required
Array of objects (IdentifierInRequest)

Responses

Request samples

Content type
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets the version history of an item.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a description of a repository item. The description contains identification, naming, and summary information, but not the entire contents of the item.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>
version
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "itemType": "1e99f8fe-923d-4544-a258-891e2461226e",
  • "agencyId": "string",
  • "version": 0,
  • "identifier": "14d3030c-3b61-4070-b902-342f80e99364",
  • "compositeId": {
    },
  • "versionDate": "2019-08-24T14:15:22Z",
  • "versionResponsibility": "string",
  • "versionRationale": {
    },
  • "summary": {
    },
  • "itemName": {
    },
  • "label": {
    },
  • "description": {
    },
  • "displayLabel": "string",
  • "isPublished": true,
  • "isDeprecated": true,
  • "tags": [
    ]
}

Gets descriptions of multiple repository items. The descriptions contain identification, naming, and summary information, but not the entire contents of the item.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
required
Array of objects (IdentifierInRequest)

Responses

Request samples

Content type
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Permission

Adds the specified permissions to the repository.

Required permissions: ColecticaAdministrator.

Request Body schema:

Responses

Request samples

Content type
{ }

Gets all permissions that apply to the specified items and item types.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
Array of objects (IdentifierInRequest)
itemTypes
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "identifiers": [
    ],
  • "itemTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "identifierPermissions": [
    ],
  • "typePermissions": [
    ]
}

Removes the specified permissions from the repository.

Required permissions: ColecticaAdministrator.

Request Body schema:
permissionIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
{
  • "permissionIds": [
    ]
}

Query

Gets the repository item descriptions for items that match the specified relationship search parameters. The search will query for items referenced by the target item specified in the search facet.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
itemTypes
required
Array of strings <uuid> [ items <uuid > ]
required
object (IdentifierInRequest)
useDistinctResultItem
boolean
useDistinctTargetItem
boolean

Responses

Request samples

Content type
{
  • "itemTypes": [
    ],
  • "targetItem": {
    },
  • "useDistinctResultItem": true,
  • "useDistinctTargetItem": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets the repository item descriptions for items that match the specified relationship search parameters. The search will query for items that reference the target item specified in the search facet.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
itemTypes
required
Array of strings <uuid> [ items <uuid > ]
required
object (IdentifierInRequest)
useDistinctResultItem
boolean
useDistinctTargetItem
boolean

Responses

Request samples

Content type
{
  • "itemTypes": [
    ],
  • "targetItem": {
    },
  • "useDistinctResultItem": true,
  • "useDistinctTargetItem": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets a list of items referenced by the specified item, according to the provided search options.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
itemTypes
required
Array of strings <uuid> [ items <uuid > ]
required
object (IdentifierInRequest)
useDistinctResultItem
boolean
useDistinctTargetItem
boolean

Responses

Request samples

Content type
{
  • "itemTypes": [
    ],
  • "targetItem": {
    },
  • "useDistinctResultItem": true,
  • "useDistinctTargetItem": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets a list of items that reference the specified item, according to the provided search options.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
itemTypes
required
Array of strings <uuid> [ items <uuid > ]
required
object (IdentifierInRequest)
useDistinctResultItem
boolean
useDistinctTargetItem
boolean

Responses

Request samples

Content type
{
  • "itemTypes": [
    ],
  • "targetItem": {
    },
  • "useDistinctResultItem": true,
  • "useDistinctTargetItem": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets a matrix representing all items in a set and the relationships among those items.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
required
Array of objects (IdentifierInRequest)
required
object (RelationshipFacet)

Responses

Request samples

Content type
{
  • "rootItems": [
    ],
  • "facet": {
    }
}

Response samples

Content type
application/json
{
  • "edges": [
    ],
  • "reverseTraversal": true,
  • "roots": [
    ],
  • "predicate": "eeb41ffe-67db-4185-b921-edc0db333e91"
}

Gets a matrix representing all items in a set and the relationships among those items.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
required
Array of objects (IdentifierInRequest)
required
object (RelationshipFacet)

Responses

Request samples

Content type
{
  • "rootItems": [
    ],
  • "facet": {
    }
}

Response samples

Content type
application/json
{
  • "edges": [
    ],
  • "reverseTraversal": true,
  • "roots": [
    ],
  • "predicate": "eeb41ffe-67db-4185-b921-edc0db333e91"
}

Searches the specified the repository for items, according to the provided search options.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
cultures
Array of strings
tags
Array of strings
itemTypes
Array of strings <uuid> [ items <uuid > ]
languageSortOrder
Array of strings
maxResults
integer <int32>
rankResults
boolean
resultOffset
integer <int32>
nextResult
integer <int64>
resultOrdering
integer <int32> (SearchResultOrdering)
Enum: 0 1 2 3 4
searchDepricatedItems
boolean
searchLatestVersion
boolean
searchSetPredicate
string <uuid>
Array of objects (IdentifierInRequest)
searchTargets
Array of integers <int32> (DdiStringType) [ items <int32 > ]
Items Enum: 0 1 2 3 4 6 7 8 9 10 11 30 31
searchTerms
Array of strings
usePrefixSearch
boolean
returnIdentifiersOnly
boolean

Responses

Request samples

Content type
{
  • "cultures": [
    ],
  • "tags": [
    ],
  • "itemTypes": [
    ],
  • "languageSortOrder": [
    ],
  • "maxResults": 0,
  • "rankResults": true,
  • "resultOffset": 0,
  • "nextResult": 0,
  • "resultOrdering": 0,
  • "searchDepricatedItems": true,
  • "searchLatestVersion": true,
  • "searchSetPredicate": "5e8736c6-45ff-477b-8c02-e2d0c13aa1b8",
  • "searchSets": [
    ],
  • "searchTargets": [
    ],
  • "searchTerms": [
    ],
  • "usePrefixSearch": true,
  • "returnIdentifiersOnly": true
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "totalResults": 0,
  • "returnedResults": 0,
  • "nextResult": 0,
  • "databaseTime": {
    },
  • "repositoryTime": {
    }
}

Searches the specified the repository for items, according to the provided search options.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
tags
Array of strings
itemTypes
Array of strings <uuid> [ items <uuid > ]
maxResults
integer <int32>
nextResult
integer <int64>
searchDepricatedItems
boolean
searchLatestVersion
boolean
Array of objects (IdentifierInRequest)
Array of objects (IdentifierInRequest)
returnIdentifiersOnly
boolean
Array of objects (TextPropertyFacet)
Array of objects (DatePropertyFacet)
Array of objects (CodeValuePropertyFacet)
Array of objects (BooleanPropertyFacet)
Array of objects (LocatorPropertyFacet)

Responses

Request samples

Content type
{
  • "tags": [
    ],
  • "itemTypes": [
    ],
  • "maxResults": 0,
  • "nextResult": 0,
  • "searchDepricatedItems": true,
  • "searchLatestVersion": true,
  • "searchParentSets": [
    ],
  • "searchChildSets": [
    ],
  • "returnIdentifiersOnly": true,
  • "textFacets": [
    ],
  • "dateFacets": [
    ],
  • "codeValueFacets": [
    ],
  • "booleanFacets": [
    ],
  • "locatorFacets": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "returnedResults": 0,
  • "nextResult": 0,
  • "databaseTime": {
    },
  • "repositoryTime": {
    }
}

Searches the specified set of items according to the provided search options.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
required
object (IdentifierInRequest)
required
object (SetSearchFacet)

Responses

Request samples

Content type
{
  • "rootItem": {
    },
  • "facet": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Rating

Adds a rating to the specified item.

Required permissions: ColecticaAdministrator or ColecticaUser.

path Parameters
agency
required
string
id
required
string <uuid>
version
required
integer <int64>
Request Body schema:
integer <int32>

Responses

Request samples

Content type
0
0

Gets the ratings for the specified item.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>
version
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Replication

Applies a tag to an item in the repository.

Required permissions: ColecticaAdministrator or ColecticaUser.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Request a replication from one repository to another

Required permissions: ColecticaAdministrator or ColecticaUser.

Request Body schema:
object (IdentifierInRequest)
targetRepositoryId
string
requesterEmail
string

Responses

Request samples

Content type
{
  • "rootItem": {
    },
  • "targetRepositoryId": "string",
  • "requesterEmail": "string"
}

/api/v1/replication/allowed-initial-states

Responses

Response samples

Content type
application/json
{
  • "allowedStates": [
    ]
}

Gets the allowed target states that an item may transition to, based on its current state.

Required permissions: ColecticaAdministrator or ColecticaUser.

Request Body schema:

The identifier of the item to have its state changed

agencyId
required
string non-empty
identifier
required
string <uuid>
version
required
integer <int64>

Responses

Request samples

Content type
{
  • "agencyId": "string",
  • "identifier": "14d3030c-3b61-4070-b902-342f80e99364",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "allowedStates": [
    ]
}

Requests a state change for an item on a repository.

Required permissions: ColecticaAdministrator or ColecticaUser.

Request Body schema:
serverId
string
itemId
string
stateFamily
string
targetState
string
scheduledReplicationTime
string <date-time>
userName
string
email
string

Responses

Request samples

Content type
{
  • "serverId": "string",
  • "itemId": "string",
  • "stateFamily": "string",
  • "targetState": "string",
  • "scheduledReplicationTime": "2019-08-24T14:15:22Z",
  • "userName": "string",
  • "email": "string"
}

Repository

Gets information about the repository and the items it contains.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Responses

Response samples

Content type
application/json
{
  • "citation": {
    },
  • "repositories": {
    },
  • "canRead": true,
  • "canAdministrator": true,
  • "canWrite": true
}

Gets statistics about the content in the repository.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Responses

Response samples

Content type
application/json
{
  • "citation": {
    },
  • "repositories": {
    },
  • "canRead": true,
  • "canAdministrator": true,
  • "canWrite": true,
  • "totalItems": 0,
  • "totalRevisions": 0,
  • "itemCounts": {
    },
  • "itemRevisionCounts": {
    },
  • "totalSize": 0
}

Set

Gets the set of all items under the specified root.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>
version
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the set of all items under the specified root. The returned identifiers include the type of each item.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>
version
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the set of items defined by the specified root. Each item in the set will have the latest version number for that item.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>
query Parameters
version
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Setting

Gets the repository setting with the specified name.

Required permissions: ColecticaAdministrator.

path Parameters
setting
required
string

Responses

Response samples

Content type
application/json
{
  • "settingName": "string",
  • "value": "string",
  • "longValue": 0
}

Removes the repository setting with the specified name.

Required permissions: ColecticaAdministrator.

path Parameters
setting
required
string

Responses

Gets all the repository settings.

Required permissions: ColecticaAdministrator.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds or updates a repository setting.

Required permissions: ColecticaAdministrator.

Request Body schema:
settingName
string
value
string
longValue
integer <int64>

Responses

Request samples

Content type
{
  • "settingName": "string",
  • "value": "string",
  • "longValue": 0
}

Tag

Applies a tag to an item in the repository.

Required permissions: ColecticaAdministrator or ColecticaUser.

path Parameters
agency
required
string
id
required
string <uuid>
version
required
integer <int64>
tag
required
string

Responses

Removes a tag from an item in the repository.

Required permissions: ColecticaAdministrator or ColecticaUser.

path Parameters
agency
required
string
id
required
string <uuid>
version
required
integer <int64>
tag
required
string

Responses

Gets the tags applied to the specified item in the repository.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>
version
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • "string"
]

Token

/token/CreateToken

Request Body schema:
username
string
password
string

Responses

Request samples

Content type
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expires": "2019-08-24T14:15:22Z"
}

/token/CreateWindowsToken

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expires": "2019-08-24T14:15:22Z"
}

Transaction

Create a new Repository transaction

Required permissions: ColecticaAdministrator or ColecticaUser.

Responses

Response samples

Content type
application/json
{
  • "transactionId": 0,
  • "persistentId": "458e34e7-16d0-4972-aad5-3b89a77d7d32",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "transactionType": 0,
  • "username": "string",
  • "itemCount": 0,
  • "propagatedItemCount": 0,
  • "totalItemCount": 0,
  • "data": "string"
}

Get Transaction metadata

Required permissions: ColecticaAdministrator, ColecticaUser

Request Body schema:
Array
integer <int64>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
application/json
[
  • {
    }
]

Get Transaction metadata

Required permissions: ColecticaAdministrator, ColecticaUser

Request Body schema:
startingTransactionId
integer <int64>
maxResultSize
integer <int32>
descending
boolean

Responses

Request samples

Content type
{
  • "startingTransactionId": 0,
  • "maxResultSize": 0,
  • "descending": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Register the items in the transaction

Required permissions: ColecticaUser, or ColecticaGuest.

Request Body schema:
object
setName
string
namedOptions
Array of strings
transactionType
integer <int32> (RepositoryTransactionType)
Enum: 0 1 2 3 4 5 6
Array of objects (IdentifierTriple)
transactionId
integer <int64>

Responses

Request samples

Content type
{
  • "versionRationale": {
    },
  • "setName": "string",
  • "namedOptions": [
    ],
  • "transactionType": 0,
  • "scopedSets": [
    ],
  • "transactionId": 0
}

Response samples

Content type
application/json
{
  • "userCommitted": [
    ],
  • "systemCommitted": [
    ],
  • "notProcessed": [
    ],
  • "transaction": {
    }
}

Cancel a transaction

Required permissions: ColecticaUser, or ColecticaGuest.

Request Body schema:
transactionId
integer <int64>

Responses

Request samples

Content type
{
  • "transactionId": 0
}

Response samples

Content type
application/json
{
  • "transactionId": 0,
  • "persistentId": "458e34e7-16d0-4972-aad5-3b89a77d7d32",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "transactionType": 0,
  • "username": "string",
  • "itemCount": 0,
  • "propagatedItemCount": 0,
  • "totalItemCount": 0,
  • "data": "string"
}

Add items to a transaction to be registered

Required permissions: ColecticaUser, or ColecticaGuest.

Request Body schema:
transactionId
integer <int64>
Array of objects (RepositoryItem)

Responses

Request samples

Content type
{
  • "transactionId": 0,
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "transactionId": 0,
  • "persistentId": "458e34e7-16d0-4972-aad5-3b89a77d7d32",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "transactionType": 0,
  • "username": "string",
  • "itemCount": 0,
  • "propagatedItemCount": 0,
  • "totalItemCount": 0,
  • "data": "string"
}

Get Transaction metadata

Required permissions: ColecticaAdministrator, ColecticaUser

query Parameters
transactionId
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

VersionNumber

Gets the latest version number of a repository item.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>

Responses

Response samples

Content type
application/json
0
0

Gets the latest version number of the specified repository item that has the specified tag.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>
tag
required
string

Responses

Response samples

Content type
application/json
0
0

Gets the latest version numbers of multiple items.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Request Body schema:
required
Array of objects (IdentifierInRequest)

Responses

Request samples

Content type
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets a list of all versions of the specified item.

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

path Parameters
agency
required
string
id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]