Die BPC Version 4.1 wird nicht mehr gewartet.

Sollten Sie diese BPC Version nutzen, empfehlen wir Ihnen eine Migration auf eine aktuelle Version. Die Dokumentation zur neusten BPC Version finden Sie hier. Sollten Sie Fragen haben, wenden Sie sich bitte an unseren Support.

Data Management API

Alle API Calls müssen wie folgt abgesetzt werden:

  • URL: http://<domain | ip>:<port>/ibis/servlet/IBISHTTPUploadServlet/VAM_api_protocol

  • METHOD: POST

  • AUTHORIZATION: Basic Auth

  • BODY: <API CALL>

Username/Passwort für Basic Auth werden in INUBIT in der Benutzergruppe "VAM" im Workflow VAM_api_interface_http im Connector VAM_api_http_listener_protocol festgelegt.

Domain/IP/Port beziehen sich auf die URL, unter der INUBIT erreichbar ist.

Context: Template

Methode Request Parameter Response Body

create

  • template (Template): template

  • strict (boolean): whether deprecated features (non-QName attribute keys) are disallowed

  • return (boolean): return created template (default: false)

template (Template): created template (if return is true)

delete

  • id (nonNegativeInteger): template id

or

  • customId (string): template custom id

get

  • id (nonNegativeInteger): template id

or

  • customId (string): template custom id

  • optional (boolean): treat missing template not as an error

  • withoutHiddenAttributes (boolean): whether hidden attributes are not included

template (Template): template

getImage

  • id (nonNegativeInteger): template id

or

  • customId (string): template custom id

image (base64): base64 encoded PNG image (64 x 64 pixels)

query

  • start (nonNegativeInteger): paging start

  • limit (nonNegativeInteger): paging limit

  • filters (Filters): array of filters

  • sorters (Sorters): array of sorters

  • withoutHiddenAttributes (boolean): whether hidden attributes are not included

  • total (nonNegativeInteger): total number of templates

  • templates (Templates): templates

setImage

either

  • id (nonNegativeInteger): template id

or

  • customId (string): template custom id

  • image (base64): base64 encoded PNG image (64 x 64 pixels)

update

  • template (Template): template

  • strict (boolean): whether deprecated features (non-QName attribute keys) are disallowed

  • return (boolean): return updated template (default: false)

template (Template): updated template (if return equalsis true)

getActionAttributes

  • template (Template): only the id or customId is required

  • action (Action): only the key is required

  • parameters: array action parameters (attribute)

  • columns (optional): array of columns when executed from a grid overview (Frontend)

  • custom (any)

attributes (Attributes): attributes to be passed to executeAction

executeAction

  • template (Template): only the id or customId is required

  • action (Action): only the key is required

  • parameters: array action parameters (attribute)

  • columns (optional): array of columns when executed from a grid overview (Frontend)

  • custom (any)

  • message (string): message (optional)

  • download: download (optional)

  • custom: any (optional)

  • refresh (boolean): optional - reload (all) asset data (because the action may have changed it)

Context: Asset

Method Request Parameters Response Body

create

  • asset (Asset): asset (optional; but non-use is deprecated)

if asset/version/template/id or customId are not filled:
either

  • templateId (nonNegativeInteger): template id

or

  • templateCustomId (string): template custom id

  • versionComment (string) - intentionally separate from 'asset'

    'versionComment' is intentionally separate from 'asset'

  • requiredOverride (boolean) - whether "required" validation is skipped

  • return (boolean): return created asset (default: false)

  • returnParameters (any): parameters for 'get' request of 'return'

asset (Asset): created asset (full if return is true, otherwise just the id)

update

either create a new version:

  • asset (Asset): asset, containing id or (customId + (template/id or template/customId))

  • versionComment (string)

    'versionComment' is intentionally separate from 'asset'

  • activationPolicy (string): whether the new version should be activated - "true", "false", or "ifHEADActive" (default value) - only meaningful if the feature "inactive versions" is enabled

  • requiredOverride (boolean) - whether "required" validation is skipped

  • onlyIfChanged (boolean) - do nothing if there are no changes to the preceding version

or update unversioned attributes only:

  • unversionedAttributesOnly (True)

  • asset as above

  • requiredOverride as above

  • onlyIfChanged as above

or, if the feature "inactive versions" is enabled, activate an existing version:

  • either id: asset id or customId + (templateId or templateCustomId)

  • updatedOn: version to activate: possible values "HEAD" or <updatedOn>

further parameters:

  • return (boolean): return updated asset (default: false)

  • returnParameters (any): parameters for 'get' request of 'return'

  • asset (Asset): updated asset (if return is true)

  • unchanged (True): present if onlyIfChanged and there are no changes

delete

  • either id (nonNegativeInteger): asset id
    or

  • customId + (templateId or templateCustomId)

  • unlinkChildAssets (boolean): if true, existing child assets are unlinked; if false (default value) and there are existing child assets, the operation fails

get

  • either id (nonNegativeInteger): asset id
    or

  • customId + (templateId or templateCustomId)

  • updatedOn (string or dateTime): asset version: possible values "HEAD", "ACTIVE" or <updatedOn> (default: ACTIVE) other (string): another asset version to include in "allVersions" - possible values: "ACTIVE", "HEAD", "PREVIOUS", "NEXT" or <updatedOn> (default is not to include any other version)

  • withoutHiddenAttributes (boolean): whether hidden attributes are not included

  • optional (boolean): treat missing asset not as an error

asset (Asset): asset

query

  • start (nonNegativeInteger): paging start

  • limit (nonNegativeInteger): paging limit

  • filters (Filters): array of filters

  • sorters (Sorters): array of sorters

  • sortMode: case-insensitive sort? (possible values: '', 'ci', 'user', 'user_ci') - only used for string attribute values and asset displayName/customId/description

  • verbosity (nonNegativeInteger): 2 includes child assets (but not joinedChildAssetIds as it would be redundant), 1 includes attributes and joinedChildAssetIds; 5 is a special format for the frontend tree view (default: 0)

  • withoutHiddenAttributes: whether hidden attributes are not included

  • withoutAttributeGroups: list[string] - regexes for (1st level) attribute groups that are not output (performance optimization)

  • restricted (boolean): whether assets of restricted templates should also be queried (Some options are then not supported, e.g. verbosity)

  • getActions (boolean): if true also return all actions

  • total (nonNegativeInteger): total number of assets

  • queries (Queries): queries (only if getQueries is true)

  • user (User): user (only if getUser is true)

  • assets (Assets): assets

executeAction

  • template (Template): only the id or customId is required

  • action (Action): only the key is required

  • filters (Filters): array of filters (To execute the action for a specific asset, use a filter for id or for customId)

  • sorters (Sorters): array of sorters

  • verbosity (nonNegativeInteger): 1 includes attributes and versions (default: 0) - deprecated, can be defined in the Action itself

  • parameters: array action parameters (attribute)

  • columns (optional): array of columns when executed from a grid overview (Frontend) - since Version 3.3.1

  • custom (any)

    "custom" input and output are a customization point for custom UIs that reuse the Data Management backend

  • total (nonNegativeInteger): total number of assets for which the action is executed

  • message (string): message (optional)

  • download: download (optional)

  • custom: any (optional)

  • refresh (boolean): optional - reload the asset data (because the action may have changed it)

getActionAttributes

  • template (Template): only the id or customId is required

  • action (Action): only the key is required

  • filters (Filters): array of filters (To execute the action for a specific asset, use a filter for id or for customId)

  • sorters (Sorters): array of sorters

  • verbosity (nonNegativeInteger): 1 includes attributes and versions (default: 0) - deprecated, can be defined in the Action itself

  • parameters: array action parameters (attribute)

  • columns (optional): array of columns when executed from a grid overview (Frontend) - since Version 3.3.1

  • custom (any)

    "custom" input and output are a customization point for custom UIs that reuse the Data Management backend

attributes (Attributes): attributes to be passed to executeAction
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen