Jump to

• Request
• Response

Update a Device Configuration Action

put

/api/config/Actions/{id}

Updates the properties of the device configuration action that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The device configuration action ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionName: string
  Action Name

  Example: Example Action Name
• Actions: array Actions
• ResultTimeout: integer
  Timeout for all commands

  Example: 30

{
    "properties":{
        "ActionName":{
            "description":"Action Name",
            "type":"string",
            "example":"Example Action Name"
        },
        "ResultTimeout":{
            "description":"Timeout for all commands",
            "type":"integer",
            "example":"30"
        },
        "Actions":{
            "$ref":"#/components/schemas/Actions"
        }
    }
}

Nested Schema : Actions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ActionOrder":{
                "description":"The 0-based order to run commands",
                "type":"integer",
                "example":1
            },
            "ConfigActionProfileID":{
                "description":"ID linking the action back to the parent actions profile.",
                "type":"integer",
                "example":2
            },
            "DisplayActionOutput":{
                "description":"Whether to save output of command",
                "type":"boolean",
                "example":0
            },
            "ReadAction":{
                "description":"Change Prompt before running command",
                "type":"string",
                "example":"Example Read Action"
            },
            "WriteAction":{
                "description":"Command to run",
                "type":"string",
                "example":"Example Write Action"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ActionOrder: integer
  The 0-based order to run commands

  Example: 1
• ConfigActionProfileID: integer
  ID linking the action back to the parent actions profile.

  Example: 2
• DisplayActionOutput: boolean
  Whether to save output of command

  Example: 0
• ReadAction: string
  Change Prompt before running command

  Example: Example Read Action
• WriteAction: string
  Command to run

  Example: Example Write Action

{
    "type":"object",
    "properties":{
        "ActionOrder":{
            "description":"The 0-based order to run commands",
            "type":"integer",
            "example":1
        },
        "ConfigActionProfileID":{
            "description":"ID linking the action back to the parent actions profile.",
            "type":"integer",
            "example":2
        },
        "DisplayActionOutput":{
            "description":"Whether to save output of command",
            "type":"boolean",
            "example":0
        },
        "ReadAction":{
            "description":"Change Prompt before running command",
            "type":"string",
            "example":"Example Read Action"
        },
        "WriteAction":{
            "description":"Command to run",
            "type":"string",
            "example":"Example Write Action"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the updated device configuration action.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/configActionsRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the updated device configuration action.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the updated device configuration action.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/configActionsRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the updated device configuration action.

Show Source

• Array of: object configActionsRead

{
    "description":"The properties of the updated device configuration action.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/configActionsRead"
    }
}

Nested Schema : configActionsRead

Type: object

Show Source

• ActionCount: integer
  The number of actions to be executed.

  Example: 1
• ActionName: string
  Descriptor for the group of actions to be executed.

  Example: Example Action Name
• Actions: array Actions
• ConfigActionProfileID: integer
  Config Action Profile ID

  Example: 1001
• ResultTimeout: integer
  Timeout for all commands

  Example: 30

{
    "type":"object",
    "properties":{
        "ActionCount":{
            "description":"The number of actions to be executed.",
            "type":"integer",
            "example":"1"
        },
        "ActionName":{
            "description":"Descriptor for the group of actions to be executed.",
            "type":"string",
            "example":"Example Action Name"
        },
        "Actions":{
            "$ref":"#/components/schemas/Actions"
        },
        "ConfigActionProfileID":{
            "description":"Config Action Profile ID",
            "type":"integer",
            "example":"1001"
        },
        "ResultTimeout":{
            "description":"Timeout for all commands",
            "type":"integer",
            "example":"30"
        }
    }
}

Nested Schema : Actions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ActionOrder":{
                "description":"The 0-based order to run commands",
                "type":"integer",
                "example":1
            },
            "ConfigActionProfileID":{
                "description":"ID linking the action back to the parent actions profile.",
                "type":"integer",
                "example":2
            },
            "DisplayActionOutput":{
                "description":"Whether to save output of command",
                "type":"boolean",
                "example":0
            },
            "ReadAction":{
                "description":"Change Prompt before running command",
                "type":"string",
                "example":"Example Read Action"
            },
            "WriteAction":{
                "description":"Command to run",
                "type":"string",
                "example":"Example Write Action"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ActionOrder: integer
  The 0-based order to run commands

  Example: 1
• ConfigActionProfileID: integer
  ID linking the action back to the parent actions profile.

  Example: 2
• DisplayActionOutput: boolean
  Whether to save output of command

  Example: 0
• ReadAction: string
  Change Prompt before running command

  Example: Example Read Action
• WriteAction: string
  Command to run

  Example: Example Write Action

{
    "type":"object",
    "properties":{
        "ActionOrder":{
            "description":"The 0-based order to run commands",
            "type":"integer",
            "example":1
        },
        "ConfigActionProfileID":{
            "description":"ID linking the action back to the parent actions profile.",
            "type":"integer",
            "example":2
        },
        "DisplayActionOutput":{
            "description":"Whether to save output of command",
            "type":"boolean",
            "example":0
        },
        "ReadAction":{
            "description":"Change Prompt before running command",
            "type":"string",
            "example":"Example Read Action"
        },
        "WriteAction":{
            "description":"Command to run",
            "type":"string",
            "example":"Example Write Action"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top