/v1/files/{id}

patch

https://api.remberg.de/v1/files/{id}

Update the metadata of a file or folder by its unique identifier.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Internal file id to change the metadata for a file or folder.

Body Params

name

string

Update the existing name.

description

string

Update the existing description.

isPublic

boolean

If this parameter is set to true, the uploaded files or folders will be visible in the portal.

assetType

string

deprecated

Update or add an AssetType assignment for a file or a folder.. You can use assetTypes instead to assign multiple assetTypes

assetNumber

string

deprecated

Update or add an assetNumber and assetType assignment for a file or a folder. You can use assetNumbers instead to assign multiple assets

assetTypes

array of strings

Specify a list of assetTypes to assign a file to them.

assetTypes

assetNumbers

array of strings

Specify a list of assetNumbers to assign a file to them.

assetNumbers

removeAssetTypes

array of strings

Specify a list of assetTypes to remove from a file assignment.

removeAssetTypes

removeAssetNumbers

array of strings

Specify a list of assetNumbers to remove from a file assignment.

removeAssetNumbers

isAddedToKnowledgeBase

boolean

Specify if the file should be added to the knowledge base for remberg AI.

partNumbers

array of strings

Specify a list of partNumbers to assign a file to them.

partNumbers

removePartNumbers

array of strings

Specify a list of partNumbers to remove from a file assignment.

removePartNumbers

partTemplateNumbers

array of strings

Specify a list of partTemplateNumbers to assign a file to them.

partTemplateNumbers

removePartTemplateNumbers

array of strings

Specify a list of partTemplateNumbers to remove from a file assignment.

removePartTemplateNumbers

organizationNumbers

array of strings

Specify a list of organizationNumbers to assign a file to them.

organizationNumbers

removeOrganizationNumbers

array of strings

Specify a list of organizationNumbers to remove from a file assignment.

removeOrganizationNumbers

Headers

remberg-active-site-ref

string

^s[1-9]\d*$

The site the request acts on, e.g. s2. You find it in the remberg web app URL (e.g. /s2/) or next to the site name under Settings → Sites. If your account has access to more than one site, send this header on every request; site-specific requests without it fail with 403 ACTIVE_SITE_UNAVAILABLE. With access to a single site, that site is used when the header is omitted. A site your account cannot access fails with 403 ACTIVE_SITE_UNAVAILABLE; a record that belongs to another site returns 404.

Responses

400

Missing or invalid required parameter/s

403

Forbidden

404

Not Found

409

Duplicate asset serialNumber

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200