Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET system_files/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns meta data information used with the Import & Export methods.

Resource URL

http://{host}/api/2.0/system_files/meta/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/system_files/meta/.json

Code Block
languagejson
{ "ImportExportOptions": { "1": "All", "2": "Users", "3": "Network, Device Name, License Sharing State", "4": "Channels and Scheduling", "5": "Threshold Sets", "6": "Notification Sets and Agents", "7": "DNS, NTP, PTP", "8": "External IRD", "9": "Layouts", "10": "Encoders", "11": "Channels Monitoring State", "12": "Time Zone Settings

GET system_files/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns meta data information used with the Import & Export methods.

Resource URL

http://{host}/api/2.0/system_files/meta/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/system_files/meta/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "ImportExportOptions": {
        "1": "All",
        "
13
2": "
Key Servers
Users",
        "
14
3": "
Certificates"
Network, Device Name, License Sharing State",
    
} }

 

 

GET system_files

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of configuration files currently available in the system.

Resource URL

http://{host}/api/2.0/system_files/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/system_files/.json

Code Block
languagejson
[ {
    "4": "Channels and Scheduling",
        "5": "Threshold Sets",
        "6": "Notification Sets and Agents",
        "7": "DNS, NTP, PTP",
        "
SystemFile
8": 
{
"External IRD",
        "
id
9": 
15
"Layouts",
        
"
filename
10": "
mcm9011_2021_05_02.xml
Encoders",

        "
description
11": "
MCM-9000 configuration
Channels Monitoring State",
        
"
size
12": 
315245,
"Time Zone Settings",
        
"
version
13": "
5.5.0dbg7", "modified": "1619961399292",
Key Servers",
        "
created
14": "
1619961399292
Certificates"

    
}
},
}

 


 

GET system_files

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of configuration files currently available in the system.

Resource URL

http://{host}/api/2.0/system_files/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/system_files/.json

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        "SystemFile": {
            "id": 15,
            "filename": "mcm9011_2021_05_02.xml",
            "description": "MCM-9000 configuration",
            "size": 315245,
            "version": "5.5.0dbg7",
            "modified": "1619961399292",
            "created": "1619961399292"
        }
    },
    {
        "SystemFile": {
            "id": 16,
            "filename": "mcm9011_2021_05_02_01.xml",
            "description": "MCM-9000 configuration",
            "size": 224896,
            "version": "5.5.0dbg7",
            "modified": "1619961442811",
            "created": "1619961442811"
        }
    }
]

 


DELETE system_files/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes a single specific File.

Resource URL

http://{host}/api/2.0/system_files/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired system file to be deleted.

Example Request

DELETE 

  1. http://44.235.52.211/api/2.0/system_files/5/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "success": true
}


 

GET system_files/command/importConfigurationFile/{file_id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Imports & activates a specific configuration file into the system.

Resource URL

http://{host}/api/2.0/system_files/command/importConfigurationFile/{file_id}.format?options[]=2&options[]=3

Parameters

Parameter

Data Type

Description

file_id
(required)

integer

The ID of the desired system file to be imported.

options[]=value
(required)

integer

Configuration file to be ingested. For example, if you need all the configuration files write options[]=1.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/system_files/command/importConfigurationFile/15/.json?options[]=2&options[]=3&options[]=5

Expand
titleRESPONSE
Code Block
languagejson
{
    
"
SystemFile
Task": {

        "id": 
16
920684,

        
"filename
"device_id": 
"mcm9011_2021_05_02_01.xml",
9011,
        
"
description
type": 
"MCM-9000 configuration",
"Import Configuration File",
        
"
size
type_id": 
224896
2,
        
"
version
mode": "
5.5.0dbg7
Starting",

        "
modified
mode_id": 
"1619961442811"
1,
        "status": null,
  
"created": "1619961442811"
      "description": null,
   
}
     
} ]

 

DELETE system_files/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes a single specific File.

Resource URL

http://{host}/api/2.0/system_files/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired system file to be deleted.

Example Request

DELETE 

  1. http://44.235.52.211/api/2.0/system_files/5/.json

GET system_files/command/importConfigurationFile/{file_id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Imports & activates a specific configuration file into the system.

Resource URL

http://{host}/api/2.0/
Code Block
languagejson
{
"total": 0,
        "completed": 0,
        "time_remained": 0,
        "
success
modified":
true }

 

 "1619961634955"
    }
}

 


 

GET system_files/command/

importConfigurationFile/{file_id}.format?options[]=2&options[]=3

Parameters

Parameter

Data Type

Description

file_id
(required)

integer

The ID of the desired system file to be imported.

options[]=value
(required)

integer

Configuration file to be ingested. For example, if you need all the configuration files write options[]=1.

exportConfigurationFile

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Exports the current system's configuration into a new configuration file.

Resource URL

http://{host}/api/2.0/system_files/command/exportConfigurationFile.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/system_files/command/

importConfigurationFile/15
  1. exportConfigurationFile/.json?options[]=

2
  1. 1&options[]=

3&options[]=5
  1. 4

Expand
titleRESPONSE
Code Block
languagejson
{
    "Task": {
        "id": 
920684
115218,
        "device_id": 9011,
        "type": "
Import
Export Configuration File",
        "type_id": 
2
3,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "
1619961634955
1619961548358"
    }
}


 

 

GET

POST system_files/command/UploadFile/

exportConfigurationFile

software

Resource

Information

Informationtions

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Exports the current system's configuration into a new configuration file

POST

Uploads software file to the MCM9000.

Resource URL

http://{host}/api/2.0/system_files/command/exportConfigurationFile.format

Example Request

GET/system_files/command/UploadFile/software

Example Request

Under the body section on the POSTMAN, insert the KEY as data (File), upload the MCM file to upgrade under the VALUE field as shown below, and click Send.

Screenshot 2024-01-25 103717.pngImage Added

POST 

  1. http://44.235.52.211/api/2.0/system_files/command/

exportConfigurationFile/.json?options[]=1&options[]=4
  1. UploadFile/software

Expand
titleRESPONSE
Code Block
languagejson
{
    "Task": {
        "id": 
115218
773281,
        "device_id": 
9011
9898,
        "type": "
Export
Software 
Configuration File
Ingest",
        "type_id": 
3
23,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "
1619961548358
1706159122746"
    }
}