Jump to

• Request
• Response
• Examples

Export Node Customization

post

/actions/export

Exports the customization and configuration of a node.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Payload schema to export nodes and node managers data to a file

Show Source

• exportNodeChain(required): boolean
  Flag indicating whether to export node chain associated with nodes, identifiers for which are mentioned in nodeIDsToExport

  Example: true
• fileName: string
  Exported data's file name

  Example: export
• nodeIDsToExport(required): array nodeIDsToExport
  List of identifiers of the nodes to export
• nodeManagersToExport(required): array nodeManagersToExport
  List of node managers to export

{
    "required":[
        "exportNodeChain",
        "nodeIDsToExport",
        "nodeManagersToExport"
    ],
    "properties":{
        "exportNodeChain":{
            "description":"Flag indicating whether to export node chain associated with nodes, identifiers for which are mentioned in nodeIDsToExport",
            "example":"true",
            "nullable":false,
            "type":"boolean"
        },
        "fileName":{
            "description":"Exported data's file name",
            "example":"export",
            "type":"string"
        },
        "nodeIDsToExport":{
            "description":"List of identifiers of the nodes to export",
            "example":"[]",
            "items":{
                "type":"string"
            },
            "nullable":false,
            "type":"array"
        },
        "nodeManagersToExport":{
            "description":"List of node managers to export",
            "example":"[]",
            "items":{
                "type":"string"
            },
            "nullable":false,
            "type":"array"
        }
    },
    "description":"Payload schema to export nodes and node managers data to a file",
    "type":"object"
}

Nested Schema : nodeIDsToExport

Type: array

List of identifiers of the nodes to export

Show Source

• Array of: string

{
    "description":"List of identifiers of the nodes to export",
    "example":"[]",
    "items":{
        "type":"string"
    },
    "nullable":false,
    "type":"array"
}

Example:

[]

Nested Schema : nodeManagersToExport

Type: array

List of node managers to export

Show Source

• Array of: string

{
    "description":"List of node managers to export",
    "example":"[]",
    "items":{
        "type":"string"
    },
    "nullable":false,
    "type":"array"
}

Example:

[]

Back to Top

Response

Supported Media Types

• application/octet-stream
• application/json

200 Response

The customization was exported successfully.

400 Response

The server cannot process the request due to a client error.

Body ()

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

401 Response

The client does not have the correct privileges.

Body ()

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

403 Response

The request was not authorized.

Body ()

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

404 Response

Requested resource cannot be found.

Body ()

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

405 Response

This method is not allowed.

Body ()

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

409 Response

The request could not be processed due to a conflict with the existing state of the resource.

Body ()

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

500 Response

The system has encountered an internal server error.

Body ()

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

Back to Top

Examples

The following example shows how to export customization by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body.

curl -X POST 'http://host:port/actions/export' -d @sampleExportCustomization.json

Example of Request Body

The following is an example of the contents of the sampleExportCustomization.json file sent as the request body.

{
  "exportNodeChain": true,
  "fileName": "abc.npl",
  "nodeIDsToExport": [
    "31eoen-otm-lnenf3zn"
  ],
  "nodeManagersToExport": [
    "NMGR-31eoen-otm-lne65v6v"
  ]
}

Example of Response Body

If successful, the response code 200 is displayed and a download link is generated.

Back to Top