JavaScript mapping files API - GET metadata of JavaScript mapping files

  • Reference

Returns a list of metadata of all JavaScript mapping files. The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/jsMappingFiles/metadata
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/jsMappingFiles/metadata

Authentication

To execute this request, you need an access token with javaScriptMappingFiles.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
nextPageKeystring

The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.

The first page is always returned if you don't specify the nextPageKey query parameter.

When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.

queryOptional
pageSizeinteger

The amount of JavaScript mapping files in a single response payload.

The maximal allowed page size is 100.

If not set, 20 is used.

queryOptional
minifiedJsFileUrlstring

Filters the resulting set of JavaScript mapping files by the minified JavaScript file URL. Only equals are taken into account.

queryOptional
fileTypestring

Filters the resulting set of JavaScript mapping files by file type.

The element can hold these values
  • MINIFIED
  • SOURCE
  • SOURCEMAP
queryOptional

Response

Response codes

CodeTypeDescription
200JavaScriptMappingFileListDto

Success.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The JavaScriptMappingFileListDto object

ElementTypeDescription
jsMappingFilesJavaScriptMappingFileDto[]

A list of JavaScript mapping files.

nextPageKeystring

The cursor for the next page of results. Has the value of null on the last page.

Use it in the nextPageKey query parameter to obtain subsequent pages of the result.

pageSizeinteger

The number of entries per page.

totalCountinteger

The total number of entries in the result.

The JavaScriptMappingFileDto object

ElementTypeDescription
fileNamestring

The name of the file.

fileTypestring

The type of the file.

The element can hold these values
  • MINIFIED
  • SOURCE
  • SOURCEMAP
minifiedJsFileUrlstring

The minified JavaScript file URL to which the mapping file belongs to.

numberOfFilesinteger

The number of files.

pinnedboolean

Whether the file is pinned and therefore not automatically deleted.

sizeinteger

The size of the file, in KB.

uploadTimestampinteger

The timestamp of the file upload, in UTC milliseconds.

zippedboolean

Whether several files are zipped into one file.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
"jsMappingFiles": [
{
"fileName": "string",
"fileType": "MINIFIED",
"minifiedJsFileUrl": "string",
"numberOfFiles": 1,
"pinned": true,
"size": 1,
"uploadTimestamp": 1,
"zipped": true
}
],
"nextPageKey": "AQAAABQBAAAABQ==",
"pageSize": 1,
"totalCount": 1
}
{
"error": {
"code": 1,
"constraintViolations": [
{
"location": "string",
"message": "string",
"parameterLocation": "HEADER",
"path": "string"
}
],
"message": "string"
}
}