Jump to

• Request
• Response

Get meta-data info for the Local Route Table files

get

https://cloud-native-SBC-IP/files/v1/lrt

Get meta-data info for the Local Route Table files

Request

Query Parameters

• exclude_name: string
  Do not include any files that include this value in the name
• include_name: string
  Include only files that include this value in the name
• page_size: integer
  Minimum Value: 4

  Number of results to return per page
• page_start: integer
  Minimum Value: 0

  Start page of results within the paginated result set

There's no request body for this operation.

Back to Top

Response

200 Response

List of file meta-data info response

Body ()

Root Schema : FileList

Type: object

List of file meta-data

Show Source

• count: integer
  Number of items in the list provided
• files: array files
  List containing file meta-data information

{
    "description":"List of file meta-data",
    "type":"object",
    "properties":{
        "count":{
            "description":"Number of items in the list provided",
            "type":"integer"
        },
        "files":{
            "description":"List containing file meta-data information",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FileInfo"
            }
        }
    }
}

Nested Schema : files

Type: array

List containing file meta-data information

Show Source

• Array of: object FileInfo
  File meta-data information

{
    "description":"List containing file meta-data information",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FileInfo"
    }
}

Nested Schema : FileInfo

Type: object

File meta-data information

Show Source

• accessed: string (datetime)
  Date and time the file was last accessed
• created(required): string (datetime)
  Date and time the file was created
• modified: string (datetime)
  Date and time the file was last modified
• name(required): string (path)
  The file name with extension (without file type/path prefix)
• size(required): integer (int64)
  Size in bytes of the file
• type(required): string
  The type of file as determined by location

{
    "description":"File meta-data information",
    "type":"object",
    "properties":{
        "name":{
            "$ref":"#/components/schemas/FileName"
        },
        "size":{
            "description":"Size in bytes of the file",
            "type":"integer",
            "format":"int64"
        },
        "created":{
            "description":"Date and time the file was created",
            "type":"string",
            "format":"datetime"
        },
        "modified":{
            "description":"Date and time the file was last modified",
            "type":"string",
            "format":"datetime"
        },
        "accessed":{
            "description":"Date and time the file was last accessed",
            "type":"string",
            "format":"datetime"
        },
        "type":{
            "description":"The type of file as determined by location",
            "type":"string"
        }
    },
    "required":[
        "name",
        "size",
        "created",
        "type"
    ]
}

4XX Response

Error information response

Body ()

Root Schema : ErrorInfo

Type: object

Details about an error that occurred

Show Source

• error_code: integer
  HTTP response code error
• message: string
  Details for the error conditon.

{
    "description":"Details about an error that occurred",
    "type":"object",
    "properties":{
        "message":{
            "description":"Details for the error conditon.",
            "type":"string"
        },
        "error_code":{
            "description":"HTTP response code error",
            "type":"integer"
        }
    }
}

5XX Response

Error information response

Body ()

Root Schema : ErrorInfo

Type: object

Details about an error that occurred

Show Source

• error_code: integer
  HTTP response code error
• message: string
  Details for the error conditon.

{
    "description":"Details about an error that occurred",
    "type":"object",
    "properties":{
        "message":{
            "description":"Details for the error conditon.",
            "type":"string"
        },
        "error_code":{
            "description":"HTTP response code error",
            "type":"integer"
        }
    }
}

Back to Top