GET File Metadata by File Name

This endpoint is used to get specific file metadata from ER API. Application user has to provide the ercollectionid as part of header body and File Name as part of url.

URL

https://{{HOST}}/apollo/entities/filename/{fileName}

Method

GET

Required IMS Scopes

  • apollo_read

URL Path Parameters

Name Description Example Type
entityId
required		 Entity id /entities/entityId string

URL Query Parameters

Name Description Example Type
includeSystemData
optional		 Flag to include system data (default false) /entities?includeSystemData=true Boolean

Request Header Parameters

Type Value Description
Authorization
required		 Bearer {access_token} IMS access token (User should have apollo_read scope)
ercollectionid
required		 {ercollectionid} ER Collection id

Example

Request

curl -X POST 
  'https://{{HOST}}/apollo/entities/filename/testFile.txt' 
  -H 'Authorization: Bearer ACCESS_TOKEN' 
  -H 'Content-Type: application/json' 
  -H 'ercollectionid: testercollectionid'

Response

[
    {
            "entityType": "JCI_EXT__File",
            "entityName": "FileEntity",
            "id": "testId",
            "sysData": {
                file_name = testFile.txt,
                file_description = "Mango image from sample photos 11",
                file_size = 2179072,
                file_type = "image/png",
                file_rating = "5",
                file_version = "1",
                version = version
            },
            "brickEntityName": "Room",
            "brickEntitySubType": "JCI_EXT__File",
            "brickEntityType": "JCI_EXT__File",
            "isActive": true
        }
]

Errors

Error Description
400 Bad Request – The request could not be understood by the server due to malformed syntax.
403 The request can not proceed if ercollectionid is not registered or does not have any logs in ACL library.