Skip to content

Latest commit

 

History

History
120 lines (73 loc) · 1.69 KB

container.md

File metadata and controls

120 lines (73 loc) · 1.69 KB
CONTAINER

Create a new container

create(
    int <container-preset-id>,
    string <title>,
    int <folder-id>,
    HashMap <hash-map>
): ResourceInformation

Retrieve the details of a container

getDetailById(int <container-id>): HashMap

Update a container

update(int <container-id>, HashMap <hash-map>): ResourceInformation

Move a container to a folder

move(int <container-id>, int <folder-id>): ResourceInformation

Copy a container to a folder

copy(int <container-id>, int <folder-id>): ResourceInformation

Delete a container

delete(int <container-id>): bool

Update the title of a container

updateTitle(
    int <container-id>,
    string <title>
): ResourceInformation

Retrieve all containers of a mandator

getListByMandatorId(int <mandator-id>): ResourceInformation[]

Retrieve all containers in a folder

getByFolderId(int <folder-id>): ResourceInformation[]

Retrieve a container by id

getById(int <container-id>): ResourceInformation

Retrieve all related objects by type id

getByTypeId(int <type-id>, int <mandator-id>): ResourceInformation[]

Retrieve the default folder for containers

getDefaultFolderByMandatorId(int <mandator-id>): FolderInformation

Retrieve all related object type ids

getTypeIds(): ResourceTypeInformation[]

Retrieve a container by its external id

getByExternalId(string <external-id>): ResourceInformation

Get object specific details of a container

getDetailsById(int <container-id>): ContainerDetail

Retrieve all containers by their container type id

getByContainerTypeId(int <container-type-id>): ResourceInformation[]