Asset Admin
Endpoints for Asset Admin
Endpoints for Asset Admin
GET/api/v1/asset-admin/folders
Authentication: Bearer token (JWT)
foldersarray of AssetFolderResponseDtoRequired5 fieldsfoldersidnumberRequired when parent is presentField path: folders[].idnamestringRequired when parent is presentField path: folders[].nameslugstringRequired when parent is presentField path: folders[].slugfileCountnumberRequired when parent is presentField path: folders[].fileCountcreatedAtstring (date-time)Required when parent is present{
"folders": [
{}
],
"totalFileCount": 0,
"totalSizeBytes": 0,
"cdnDomain": "string",
"cdnBasePath": "string"
}unauthorized
This response has no body.
curlcurl https://api.subrite.no/api/v1/asset-admin/folders \
--header 'Authorization: Bearer <token>'POST/api/v1/asset-admin/folders
Authentication: Bearer token (JWT)
application/jsonnamestringRequiredmaxLength: 64DELETE/api/v1/asset-admin/folders/{id}
Authentication: Bearer token (JWT)
idnumberRequiredPATCH/api/v1/asset-admin/folders/{id}
Authentication: Bearer token (JWT)
idnumberRequiredapplication/jsonnamestringRequiredGET/api/v1/asset-admin/assets
Authentication: Bearer token (JWT)
pagenumberOptional1minimum: 1takenumberOptional24minimum: 1maximum: 50folderIdnumberOptionalminimum: 0kindsarray of AssetKindPOST/api/v1/asset-admin/assets
Authentication: Bearer token (JWT)
multipart/form-datafolderIdnumberOptionalminimum: 0GET/api/v1/asset-admin/assets/{id}
Authentication: Bearer token (JWT)
idnumberRequiredDELETE/api/v1/asset-admin/assets/{id}
Authentication: Bearer token (JWT)
idnumberRequiredSame fields as Delete a folder and every file it contains (hard delete) (200).
PATCH/api/v1/asset-admin/assets/{id}
Authentication: Bearer token (JWT)
idnumberRequiredapplication/jsontitlestringOptionalGET/api/v1/asset-admin/assets/{id}/download
Authentication: Bearer token (JWT)
idnumberRequiredThe file bytes, sent as an attachment.
This response has no body.
totalFileCountnumberRequiredtotalSizeBytesnumberRequiredcdnDomainstringRequiredcdnBasePathstringRequired{
"name": "string"
}idnumberRequirednamestringRequiredslugstringRequiredfileCountnumberRequiredcreatedAtstring (date-time)Required{
"id": 0,
"name": "string",
"slug": "string",
"fileCount": 0,
"createdAt": "2019-08-24T14:15:22Z"
}Same fields as Create a folder (200).
assetFolderNameInvalid
messageCodestringRequired"assetFolderNameInvalid"messagestringerrorsarray of FieldErrorRequiredunauthorized
This response has no body.
assetFolderNameConflict, assetFolderLimitReached, assetFolderDeleteInProgress
messageCodestringRequired"assetFolderNameConflict", "assetFolderLimitReached", "assetFolderDeleteInProgress"messagestringcurlcurl https://api.subrite.no/api/v1/asset-admin/folders \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "string"
}'successbooleanRequiredidnumberRequired{
"success": true,
"id": 0
}unauthorized
This response has no body.
assetFolderNotFound
messageCodestringRequired"assetFolderNotFound"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is present{
"messageCode": "assetFolderNotFound",
"message": "string",
"errors": [
{}
]
}assetFolderRenameInProgress
messageCodestringRequired"assetFolderRenameInProgress"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is present{
"messageCode": "assetFolderRenameInProgress",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/asset-admin/folders/{id}' \
--request DELETE \
--header 'Authorization: Bearer <token>'maxLength: 64{
"name": "string"
}Same fields as Create a folder (200).
{
"id": 0,
"name": "string",
"slug": "string",
"fileCount": 0,
"createdAt": "2019-08-24T14:15:22Z"
}assetFolderNameInvalid
Same fields as Create a folder (400).
{
"messageCode": "assetFolderNameInvalid",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
assetFolderNotFound
Same fields as Delete a folder and every file it contains (hard delete) (404).
{
"messageCode": "assetFolderNotFound",
"message": "string",
"errors": [
{}
]
}assetFolderNameConflict, assetFolderDeleteInProgress, assetFolderRenameInProgress
messageCodestringRequired"assetFolderNameConflict", "assetFolderDeleteInProgress", "assetFolderRenameInProgress"messagestringcurlcurl 'https://api.subrite.no/api/v1/asset-admin/folders/{id}' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "string"
}'"image", "svg", "pdf", "video", "audio", "font", "doc"searchstringOptionalsortstringOptional"uploaded"Allowed values: "name", "type", "size", "uploaded"orderstringOptional"desc"Allowed values: "asc", "desc"itemsarray of AssetResponseDtoRequired12 fieldsitemsidnumberRequired when parent is presentField path: items[].idfolderIdnumberRequired when parent is presentField path: items[].folderIdtitlestringRequired when parent is presentField path: items[].titlenamestringRequired when parent is presentField path: items[].nameurlstringRequired when parent is presentField path: items[].urlkindstringRequired when parent is presentField path: items[].kind"image", "svg", "pdf", "video", "audio", "font", "doc"mimeTypestringRequired when parent is presentField path: items[].mimeTypesizeBytesnumberRequired when parent is presentField path: items[].sizeByteswidthnumberRequired when parent is presentField path: items[].widthheightnumberRequired when parent is presentField path: items[].heightaltTextstringRequired when parent is presentField path: items[].altTextcreatedAtstring (date-time)Required when parent is presentField path: items[].createdAtmetaPageMetaRequired6 fieldsmetapagenumberRequiredField path: meta.pagetakenumberRequiredField path: meta.takecountnumberRequiredField path: meta.countpageCountnumberRequiredField path: meta.pageCounthasPreviousPagebooleanRequiredField path: meta.hasPreviousPagehasNextPagebooleanRequiredField path: meta.hasNextPage{
"items": [
{}
],
"meta": {
"page": 0,
"take": 0,
"count": 0,
"pageCount": 0,
"hasPreviousPage": true,
"hasNextPage": true
}
}badRequest
messageCodestringRequired"badRequest"messagestringerrorsarray of FieldErrorRequired7 fieldsunauthorized
This response has no body.
curlcurl https://api.subrite.no/api/v1/asset-admin/assets \
--header 'Authorization: Bearer <token>'application/jsonresultsarray of UploadResultItemDtoRequired4 fieldsresultsfileNamestringRequired when parent is presentField path: results[].fileNamesuccessbooleanRequired when parent is presentField path: results[].successassetAssetResponseDtoRequired when parent is presentCan be nullField path: results[].asset12 fieldsresults[].assetidnumberRequired when parent is presentField path: results[].asset.idfolderIdnumberRequired when parent is presentField path: results[].asset.folderIdtitlestringRequired when parent is presentField path: results[].asset.titlenamestringRequired when parent is presentField path: results[].asset.nameurlstringRequired when parent is presentField path: results[].asset.urlerrorstringRequired when parent is presentField path: results[].error{
"results": [
{}
]
}unauthorized
This response has no body.
assetFolderNotFound
Same fields as Delete a folder and every file it contains (hard delete) (404).
{
"messageCode": "assetFolderNotFound",
"message": "string",
"errors": [
{}
]
}assetFolderRenameInProgress
Same fields as Delete a folder and every file it contains (hard delete) (409).
{
"messageCode": "assetFolderRenameInProgress",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/asset-admin/assets \
--request POST \
--header 'Authorization: Bearer <token>' \
--form 'folderId=0'idnumberRequiredfolderIdnumberRequiredtitlestringRequirednamestringRequiredurlstringRequiredkindstringRequired"image", "svg", "pdf", "video", "audio", "font", "doc"mimeTypestringRequiredsizeBytesnumberRequiredwidthnumberRequiredheightnumberRequiredaltTextstringRequiredcreatedAtstring (date-time)Required{
"id": 0,
"folderId": 0,
"title": "string",
"name": "string",
"url": "string",
"kind": "image",
"mimeType": "string",
"sizeBytes": 0,
"width": 0,
"height": 0,
"altText": "string",
"createdAt": "2019-08-24T14:15:22Z"
}unauthorized
This response has no body.
assetFileNotFound
messageCodestringRequired"assetFileNotFound"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is present{
"messageCode": "assetFileNotFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/asset-admin/assets/{id}' \
--header 'Authorization: Bearer <token>'{
"success": true,
"id": 0
}unauthorized
This response has no body.
assetFileNotFound
Same fields as Get a single asset (preview modal data) (404).
{
"messageCode": "assetFileNotFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/asset-admin/assets/{id}' \
--request DELETE \
--header 'Authorization: Bearer <token>'maxLength: 255folderIdnumberOptionalminimum: 0altTextstringOptionalmaxLength: 500{
"title": "string",
"folderId": 0,
"altText": "string"
}Same fields as Get a single asset (preview modal data) (200).
{
"id": 0,
"folderId": 0,
"title": "string",
"name": "string",
"url": "string",
"kind": "image",
"mimeType": "string",
"sizeBytes": 0,
"width": 0,
"height": 0,
"altText": "string",
"createdAt": "2019-08-24T14:15:22Z"
}unauthorized
This response has no body.
assetFileNotFound, assetFolderNotFound
messageCodestringRequired"assetFileNotFound", "assetFolderNotFound"messagestringassetFileNameConflict, assetFolderRenameInProgress
messageCodestringRequired"assetFileNameConflict", "assetFolderRenameInProgress"messagestringcurlcurl 'https://api.subrite.no/api/v1/asset-admin/assets/{id}' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"title": "string",
"folderId": 0,
"altText": "string"
}'unauthorized
This response has no body.
assetFileNotFound
Same fields as Get a single asset (preview modal data) (404).
{
"messageCode": "assetFileNotFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/asset-admin/assets/{id}/download' \
--header 'Authorization: Bearer <token>'errorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "assetFolderNameInvalid",
"message": "string",
"errors": [
{}
]
}errorsarray of FieldErrorRequirederrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "assetFolderNameConflict",
"message": "string",
"errors": [
{}
]
}errorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "assetFolderNameConflict",
"message": "string",
"errors": [
{}
]
}errorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}kindstringRequired when parent is presentField path: results[].asset.kind"image", "svg", "pdf", "video", "audio", "font", "doc"mimeTypestringRequired when parent is presentField path: results[].asset.mimeTypesizeBytesnumberRequired when parent is presentField path: results[].asset.sizeByteswidthnumberRequired when parent is presentField path: results[].asset.widthheightnumberRequired when parent is presentField path: results[].asset.heightaltTextstringRequired when parent is presentField path: results[].asset.altTextcreatedAtstring (date-time)Required when parent is presentField path: results[].asset.createdAterrorsarray of FieldErrorRequirederrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "assetFileNotFound",
"message": "string",
"errors": [
{}
]
}errorsarray of FieldErrorRequirederrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "assetFileNameConflict",
"message": "string",
"errors": [
{}
]
}