Retrieve a FileMeta.

get https://qa.connect.calamp.com/connect/services/files/{id}

Returns the FileMeta or null if no FileMeta for the given Id was found.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

_self

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

Relation to the resource represented by the Link, within the context of the containing resource. While a Link represents a specific resource in the system, the 'rel' property defines the type of the association between the containing resource and the linked resource.Except for the 'self', 'first', 'last', 'next', 'prev' relations, generally it is the type of the resource at the other end of the association. E.g. 'asset', 'device', 'pegBehavior, 'role', 'primary-operator', etc.

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

groups

array of objects

Links to Groups to which the resource belongs.

groups

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

name

string

required

Name of the FileMeta

location

string

URL for FileMeta

int64

Required for PUT requests with resource object in the request body. Forbidden for POST requests with resource object in the request body. Will result in an HTTP 400 - Bad Request response.

description

string

Description for FileMeta

status

string

Defaults to 'Enabled'

Enabled Disabled Suspended Deleted Pending_Delete

createdOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only

inheritable

boolean

Defaults to false.

true

deletedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only

lastModifiedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only

version

int64

Defaults to 0

Read-only. Managed by the service. Required for PUT, ignored for POST.

account

object

required

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

validationMetaData

object

File metadata

validationStatus

object

Represents a FileMeta validation status

status

string

FileMeta validation status

reasons

array of objects

Reasons for FileMeta validation status

reasons

object

code

string

Error code for filemeta validation status

message

string

Error message for filemeta validation status

description

string

Error detail description for filemeta validation status

type

object

required

File Type
category and subType are required fields
Sample "type": {
"href": "xyzlink",
"name": "filename",
"description": "More details",
"category": "categoryxyz",
"subType": "subTypexyz"
}

403

Not authorized for this operation.

404

FileMeta not found.

417

Association expansion error

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa.connect.calamp.com/connect/services/files/id \
3
     --header 'accept: application/json'

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

application/json

200successful operation