NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve list of all configured board card printers

get

/spms/v1/configuration/printers/boardCard

This is to retrieve a list of all configured board card printers

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns a list of all printers

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Oracle Response object containing list items
  Title: Oracle Response object containing list items

  The object returned in Oracle Standard when function is executed successfully

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

Nested Schema : Oracle Response object containing list items

Type: object

Title: Oracle Response object containing list items

The object returned in Oracle Standard when function is executed successfully

Show Source

• items(optional): array items

{
    "title":"Oracle Response object containing list items",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Printer"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Printers
  Title: Printers

  Retrieves list of printers

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

Nested Schema : Printers

Type: object

Title: Printers

Retrieves list of printers

Show Source

• printerId(optional): integer
  Example: 1
• printerLocation(optional): string
  Example: PC-1234
• printerName(optional): string
  Example: Xerox 123

{
    "title":"Printers",
    "description":"Retrieves list of printers",
    "type":"object",
    "properties":{
        "printerId":{
            "type":"integer",
            "example":1
        },
        "printerName":{
            "type":"string",
            "example":"Xerox 123"
        },
        "printerLocation":{
            "type":"string",
            "example":"PC-1234"
        }
    }
}

400 Response

Unknown request found

401 Response

You do not have valid authorization

403 Response

You are not authorized to use the service

404 Response

Record not found

415 Response

Content format is not supported

500 Response

Internal server error occurred

Back to Top