Resources

speccustomimplcandidate

Publish and manage file resources.

Scope

Typical file resources are resources referenced from styles (icons, sprites) or schema documents referenced from feature data. The files are located in the folder api-resources/resources/{apiId}.

Operations

ResourcePathMethodsMedia TypesDescription
Resources
resources
GET
HTML, JSON
This operation fetches the set of file resources. For each resource the id and a link to the file is provided.
Resource
resources/{resourceId}
GET
Any
Fetches the file resource with identifier resourceId. The set of available resources can be retrieved at /resources.
Resource
resources/{resourceId}
DELETE, PUT
Any
Create, update or delete a file resource.

Path Parameters

NameResourcesDescription
resourceId
Resource
The local identifier of the resource.

Query Parameters

NameResourcesDescription
f
Resources
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.

Configuration

Options

NameDefaultDescriptionTypeSince
buildingBlock
Always RESOURCES.
string
v3.1
extensionType
Deprecated See buildingBlock.
string
v3.1
enabled
false
Enable the building block?
boolean
v3.1
caching
{}
Sets fixed values for HTTP Caching Headers for the resources.
object
v3.1
managerEnabled
false
Controls whether the resources should be able to be created and deleted via PUT and DELETE through the API.
boolean
v3.1

Examples


- buildingBlock: RESOURCES
  enabled: true
  managerEnabled: true