Jump to

• Request
• Response

Execute a CLI

post

/grid/cmd/v1/cmd/exec

Executes a CLI with the provided arguments, as a Job

Request

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Body ()

POST request to execute the CLI

Root Schema : execReq

Match All

Show Source

• object jobCommon
• object execReq-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/jobCommon"
        },
        {
            "properties":{
                "userPassword":{
                    "type":"string"
                }
            },
            "required":[
                "userPassword"
            ]
        }
    ]
}

Nested Schema : jobCommon

Type: object

Show Source

• command: array command
• flags(optional): array flags
• homeName(optional): string
• jobExpiry(optional): integer
• nodeName(optional): string
• runAsUser: string

{
    "properties":{
        "command":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "flags":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "outputDiscard"
                ]
            }
        },
        "homeName":{
            "type":"string"
        },
        "jobExpiry":{
            "type":"integer"
        },
        "nodeName":{
            "type":"string"
        },
        "runAsUser":{
            "type":"string"
        }
    },
    "required":[
        "command",
        "runAsUser"
    ]
}

Nested Schema : execReq-allOf[1]

Type: object

Show Source

• userPassword: string

{
    "properties":{
        "userPassword":{
            "type":"string"
        }
    },
    "required":[
        "userPassword"
    ]
}

Nested Schema : command

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : flags

Type: array

Show Source

• Array of: string
  Allowed Values: [ "outputDiscard" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "outputDiscard"
        ]
    }
}

Back to Top

Response

201 Response

Created

Headers

• Content-Type: string
  The content-type"application/vnd.oracle.resource+json;type=singular"

Body ()

Root Schema : job

Match All

Show Source

• object jobCommon
• object job-allOf[1]
• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.

{
    "allOf":[
        {
            "$ref":"#/definitions/jobCommon"
        },
        {
            "properties":{
                "jobId":{
                    "type":"string",
                    "readOnly":true
                },
                "status":{
                    "type":"string",
                    "enum":[
                        "Scheduled",
                        "Running",
                        "Completed",
                        "Failed",
                        "Unknown"
                    ],
                    "readOnly":true
                },
                "output":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    },
                    "readOnly":true
                },
                "outputFile":{
                    "allOf":[
                        {
                            "$ref":"#/definitions/singularResource"
                        }
                    ],
                    "readOnly":true
                },
                "processId":{
                    "type":"integer",
                    "readOnly":true
                },
                "processStatus":{
                    "type":"integer",
                    "readOnly":true
                },
                "timeStart":{
                    "type":"string",
                    "readOnly":true
                },
                "timeFinish":{
                    "type":"string",
                    "readOnly":true
                }
            },
            "required":[
                "jobId"
            ]
        },
        {
            "$ref":"#/definitions/singularResource"
        }
    ]
}

Nested Schema : jobCommon

Type: object

Show Source

• command: array command
• flags(optional): array flags
• homeName(optional): string
• jobExpiry(optional): integer
• nodeName(optional): string
• runAsUser: string

{
    "properties":{
        "command":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "flags":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "outputDiscard"
                ]
            }
        },
        "homeName":{
            "type":"string"
        },
        "jobExpiry":{
            "type":"integer"
        },
        "nodeName":{
            "type":"string"
        },
        "runAsUser":{
            "type":"string"
        }
    },
    "required":[
        "command",
        "runAsUser"
    ]
}

Nested Schema : job-allOf[1]

Type: object

Show Source

• jobId: string
  Read Only: true
• output(optional): array output
  Read Only: true
• outputFile(optional): outputFile
  Read Only: true
• processId(optional): integer
  Read Only: true
• processStatus(optional): integer
  Read Only: true
• status(optional): string
  Read Only: true

  Allowed Values: [ "Scheduled", "Running", "Completed", "Failed", "Unknown" ]
• timeFinish(optional): string
  Read Only: true
• timeStart(optional): string
  Read Only: true

{
    "properties":{
        "jobId":{
            "type":"string",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "enum":[
                "Scheduled",
                "Running",
                "Completed",
                "Failed",
                "Unknown"
            ],
            "readOnly":true
        },
        "output":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":true
        },
        "outputFile":{
            "allOf":[
                {
                    "$ref":"#/definitions/singularResource"
                }
            ],
            "readOnly":true
        },
        "processId":{
            "type":"integer",
            "readOnly":true
        },
        "processStatus":{
            "type":"integer",
            "readOnly":true
        },
        "timeStart":{
            "type":"string",
            "readOnly":true
        },
        "timeFinish":{
            "type":"string",
            "readOnly":true
        }
    },
    "required":[
        "jobId"
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

• links(optional): array links

{
    "description":"Oracle base singular resource schema definition.",
    "properties":{
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    },
    "title":"Singular Resource",
    "type":"object"
}

Nested Schema : command

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : flags

Type: array

Show Source

• Array of: string
  Allowed Values: [ "outputDiscard" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "outputDiscard"
        ]
    }
}

Nested Schema : output

Type: array

Read Only: true

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":true
}

Nested Schema : outputFile

Read Only: true

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

• href(optional): string
  URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
• mediaType(optional): string
  Media type, as defined by RFC 2046, describing the link target.
• rel(optional): string
  Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile ",
            "type":"string"
        }
    }
}

400 Response

Bad Request

Headers

• Content-Type: string
  The content-type "text/plain"

401 Response

Not Authorized

Headers

• Content-Type: string
  The content-type "text/plain"

404 Response

Not Found

Headers

• Content-Type: string
  The content-type "text/plain"

500 Response

Internal Server Error

Headers

• Content-Type: string
  The content-type "text/plain"

Back to Top