System APIs

GET system/print-connectors/{printConnectorId}

Print connector details for the provided identifier

HTTP method	GET
URI	https://api.rambase.net/system/print-connectors/{printConnectorId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {printConnectorId}	Print connector identifier Integer, minimum 100000
Successful HTTP status code	200
API resource identifier	1802, version 16

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <PrintConnector>
                                    

<PrintConnectorId

PrintConnectorId

Print connector identifier

>{Integer}</PrintConnectorId>

<Status

Status

Status of print connector

Possible domain values can be found here

>{Integer}</Status>

<Name

Name

Readable name of the print connector

>{String}</Name>

<Version

Version

Software version of the print connector

>{String}</Version>

<InstalledAt

InstalledAt

Date and time of creation

>{Datetime}</InstalledAt>

<IsOnline

IsOnline

If true it means that the print connector is online and connected to RamBase.
False means that there is no connection between RamBase and the machine the print connector is installed on.

>{Boolean}</IsOnline>

<License

License

This is the unique license of the print connector

>{String}</License>

<State

State

State of PrintConnector. Updated after fresh install by Cloud and continously report from Cloud on the current state of a Connector.

>{String}</State>

<InstalledBy

InstalledBy

The employee that installed the print connector

This field is greyed out because it is an expandable field. You have to add $expand=InstalledBy in your request URI to get this field

<EmployeeId

EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=InstalledBy in your request URI to get this field

>{Integer}</EmployeeId>

<LastName

LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=InstalledBy in your request URI to get this field

>{String}</LastName>

<FirstName

FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=InstalledBy in your request URI to get this field

>{String}</FirstName>

<EmployeeLink

EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=InstalledBy in your request URI to get this field

>{String}</EmployeeLink>

                                             </InstalledBy>
                                    

                                             <Server>
                                    

<IPAddress

IPAddress

IP address of the server the print connector is intalled on

>{String}</IPAddress>

<MACAddress

MACAddress

MAC address of the server the print connector is intalled on

>{String}</MACAddress>

<ComputerName

ComputerName

Computer name of the server the print connector is installed on

>{String}</ComputerName>

<OperatingSystem

OperatingSystem

Operating system of the server the print connector is installed on

>{String}</OperatingSystem>

                                             </Server>
                                    

                                        </PrintConnector>
                                    

{

                                             "printConnector": {
                                    

"printConnectorId

PrintConnectorId

Print connector identifier

": "{Integer}",

"status

Status

Status of print connector

Possible domain values can be found here

": "{Integer}",

"name

Name

Readable name of the print connector

": "{String}",

"version

Version

Software version of the print connector

": "{String}",

"installedAt

InstalledAt

Date and time of creation

": "{Datetime}",

"isOnline

IsOnline

If true it means that the print connector is online and connected to RamBase.
False means that there is no connection between RamBase and the machine the print connector is installed on.

": "{Boolean}",

"license

License

This is the unique license of the print connector

": "{String}",

"state

State

State of PrintConnector. Updated after fresh install by Cloud and continously report from Cloud on the current state of a Connector.

": "{String}",

"installedBy

InstalledBy

The employee that installed the print connector

This field is greyed out because it is an expandable field. You have to add $expand=InstalledBy in your request URI to get this field

": {

"employeeId

EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=InstalledBy in your request URI to get this field

": "{Integer}",

"lastName

LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=InstalledBy in your request URI to get this field

": "{String}",

"firstName

FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=InstalledBy in your request URI to get this field

": "{String}",

"employeeLink

EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=InstalledBy in your request URI to get this field

": "{String}"

},

                                                  "server": {
                                    

"iPAddress

IPAddress

IP address of the server the print connector is intalled on

": "{String}",

"mACAddress

MACAddress

MAC address of the server the print connector is intalled on

": "{String}",

"computerName

ComputerName

Computer name of the server the print connector is installed on

": "{String}",

"operatingSystem

OperatingSystem

Operating system of the server the print connector is installed on

": "{String}"

}

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Starts all output jobs in status 8 and external process status 2 for the provided print connector

AOP/100036

POST

Update this Print Connector

Update a single print connector when there is a new version available

AOP/100037

Possible error codes the response might return:

Error 100667 HTTP 404

Print connector not found