Created
July 22, 2024 20:16
-
-
Save clarkmcc/46d9e033c267c9017e4d1d5952e97ba2 to your computer and use it in GitHub Desktop.
HP SDS JetAdvantage Management Connector OpenAPI Spec
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| swagger: '2.0' | |
| info: | |
| version: v1 | |
| title: HP JetAdvantage Management Connector | |
| host: 'localhost:12350' | |
| schemes: | |
| - http | |
| paths: | |
| '/api/credentials/{deviceId}': | |
| get: | |
| tags: | |
| - Credentials | |
| summary: >- | |
| Retrieves either common or device-specific credentials from the local | |
| connector | |
| description: "Retrieves either common or device-specific credentials from the local connector. This does not read credentials from the device,\r\nbut reads what credentials have been saved on the local connector.\r\n\r\nTo read Common credentials used for all devices, use -1 for the deviceId. Otherwise, specify a deviceID to read\r\ncredentials only for a single device.\r\n\r\nResponse field details:\r\n admin: EWS/Admin credentials\r\n userName: EWS user name (typically \"Admin\") (string)\r\n password: EWS password (string)\r\n snmpV1V2Read: SNMPv1v2 read credentials (Get Community Name)\r\n password: SNMPv1v2 Read password (string)\r\n snmpV1V2ReadWrite: SNMPv1v2 read/write credentials (Set Community Name)\r\n password: SNMPv1v2 Read/Write password (string)\r\n snmpV3: SNMPv3 credentials\r\n authenticationProtocol: Usually \"MD5\" or \"SHA1\" (string)\r\n authenticationPassword: Authentication password (string)\r\n privacyProtocol: Usually \"DES\" or \"AES128\" (string)\r\n privacyPassword: Privacy password (string)\r\n userName: SNMPv3 Username (string)\r\n context: Usually \"Jetdirect\" (string)\r\n fileSystemPassword: The file system password\r\n password: File system password (string)\r\n credType: 0 for local credentials (int)\r\n \r\nSample Response:\r\n {\r\n \"admin\": {\r\n \"userName\": \"string\",\r\n \"password\": \"string\"\r\n },\r\n \"snmpV1V2Read\": null,\r\n \"snmpV1V2ReadWrite\": {\r\n \"password\": \"string\"\r\n },\r\n \"snmpV3\": null,\r\n \"fileSystemPassword\": null,\r\n \"credType\": 0\r\n }" | |
| operationId: Credentials_Get | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| parameters: | |
| - name: deviceId | |
| in: path | |
| description: 'The deviceID to get credentials for, or -1 for common credentials' | |
| required: true | |
| type: integer | |
| format: int32 | |
| responses: | |
| '200': | |
| description: Success | |
| schema: | |
| $ref: '#/definitions/DeviceCredentials' | |
| '404': | |
| description: 'Not found: No local credentials found for the specified deviceId' | |
| put: | |
| tags: | |
| - Credentials | |
| summary: >- | |
| Saves either common or device-specific credentials on the local | |
| connector | |
| description: "Saves either common or device-specific credentials on the local connector. This does not set credentials on the device,\r\nbut should match the device credentials so that the connector can communicate successfully with the device.\r\n\r\nAll desired credential types should be specified in a single request. If a credential type is omitted from the\r\nrequest, that credential type will be set to null, erasing any previously existing credential of that type.\r\n\r\nTo set Common credentials to use for all devices, use -1 for the deviceId. Otherwise, specify a deviceID to set\r\ncredentials only for that device.\r\n\r\nRequest details:\r\n admin: EWS/Admin credentials\r\n userName: EWS user name (typically \"Admin\") (string)\r\n password: EWS password (string)\r\n snmpV1V2Read: SNMPv1v2 read credentials (Get Community Name)\r\n password: SNMPv1v2 Read password (string)\r\n snmpV1V2ReadWrite: SNMPv1v2 read/write credentials (Set Community Name)\r\n password: SNMPv1v2 Read/Write password (string)\r\n snmpV3: SNMPv3 credentials\r\n authenticationProtocol: Usually \"MD5\" or \"SHA1\" (string)\r\n authenticationPassword: Authentication password (string)\r\n privacyProtocol: Usually \"DES\" or \"AES128\" (string)\r\n privacyPassword: Privacy password (string)\r\n userName: SNMPv3 Username (string)\r\n context: Usually \"Jetdirect\" (string)\r\n fileSystemPassword: The file system password\r\n password: File system password (string)\r\n \r\nSample Request:\r\n {\r\n \"admin\": {\r\n \"userName\": \"string\",\r\n \"password\": \"string\"\r\n },\r\n \"snmpV1V2ReadWrite\": {\r\n \"password\": \"string\"\r\n }\r\n }" | |
| operationId: Credentials_Put | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/x-www-form-urlencoded | |
| produces: [] | |
| parameters: | |
| - name: deviceId | |
| in: path | |
| description: 'The deviceId to save credentials for, or -1 for common credentials' | |
| required: true | |
| type: integer | |
| format: int32 | |
| - name: deviceCredentials | |
| in: body | |
| description: The credentials to store | |
| required: true | |
| schema: | |
| $ref: '#/definitions/DeviceCredentials' | |
| responses: | |
| '204': | |
| description: Success | |
| '400': | |
| description: 'Bad Request: Invalid or incomplete data was supplied to the API.' | |
| delete: | |
| tags: | |
| - Credentials | |
| summary: >- | |
| Deletes the common or specific device credentials from the local | |
| connector. | |
| description: "Deletes the common or specific device credentials from the local connector.\r\n\r\nThis removes all local connector credentials for the specified device, or all\r\nlocal common credentials if -1 is used as the deviceId." | |
| operationId: Credentials_Delete | |
| consumes: [] | |
| produces: [] | |
| parameters: | |
| - name: deviceId | |
| in: path | |
| description: >- | |
| The deviceId to delete credentials from, or -1 for common | |
| credentials. | |
| required: true | |
| type: integer | |
| format: int32 | |
| responses: | |
| '204': | |
| description: Success | |
| '/api/credentials/{deviceId}/{credentialType}': | |
| delete: | |
| tags: | |
| - Credentials | |
| summary: >- | |
| Deletes the specified part of the common or specific device credentials | |
| from the local connector. | |
| description: "Deletes the specified part of the common or specific device credentials from the local connector.\r\n\r\nThis removes part of the local connector credentials for the specified device, or part of\r\nlocal common credentials if -1 is used as the deviceId.\r\n\r\nAccepted credential types (case insensitive):\r\n \"V1Read\": SnmpV1V2Read\r\n \"V1ReadWrite\": SnmpV1V2ReadWrite\r\n \"EWSAdmin\": Admin\r\n \"V3\": SnmpV3" | |
| operationId: Credentials_Delete | |
| consumes: [] | |
| produces: [] | |
| parameters: | |
| - name: deviceId | |
| in: path | |
| description: >- | |
| The deviceId to delete credentials from, or -1 for common | |
| credentials. | |
| required: true | |
| type: integer | |
| format: int32 | |
| - name: credentialType | |
| in: path | |
| description: The type of credential to delete | |
| required: true | |
| type: string | |
| responses: | |
| '204': | |
| description: Success | |
| '404': | |
| description: CredType in the URL does not exist | |
| /api/credentials/verifyCredentials: | |
| post: | |
| tags: | |
| - Credentials | |
| summary: >- | |
| Attempts to create a verified set of credentials for the given device | |
| that work | |
| description: "Attempts to create a set of credentials that can be used to communicate with the device.\r\nThis operation may take some time since it attempts to communicate with the device, possibly multiple times.\r\n\r\nA null value that is used in spot of a real credential will be treated as the default credential by JAMC.\r\nIf one is returned with a successful state, it should be treated as default working when talking to the device.\r\nNull can be passed to JAMC on APIs as the device credentials if the default value is wished to be used.\r\n\r\nRequired request field descriptions:\r\n deviceIdentifier: Use the Addressing portion to specify either the IP Address or Hostname of the desired device\r\n tryDefaulCredentials: Add public credentials by default to every set.\r\n \r\n\r\nResponse field descriptions (Some internal or unused fields omitted for brevity):\r\n state: Overall device result for the data collection operation\r\n result: Overall device result\r\n\r\nSample request:\r\n{ \r\n \"DeviceIdentifier\": {\r\n \t\"Addressing\": {\r\n \t\t\"HostName\":\"\",\r\n \t\t\"IpAddress\":\"12.12.12.12\"\r\n \t}\r\n },\r\n \"TryDefaultCredentials\":true,\r\n \"Admin\": [{\r\n \t\"Username\":\"user\",\r\n \t\"Password\":\"password\"\r\n }],\r\n \"SnmpV1V2Read\": [{\r\n \t\"Password\":\"password\"\r\n }],\r\n \"SnmpV1V2ReadWrite\": [{\r\n \t\"Password\":\"password\"\r\n }],\r\n \"SnmpV3\": [{\r\n \t\"AuthenticationProtocol\":null,\r\n \t\"PrivacyProtocol\":null,\r\n \t\"AuthenticationPassword\":null,\r\n \t\"PrivacyPassword\":null,\r\n \t\"UserName\":null,\r\n \t\"Context\":null\r\n }]\r\n}\r\n\r\nSample response:\r\n {\r\n \"adminCredentialResponse\": {\r\n \"state\": {\r\n \"result\": \"Success\",\r\n \"reason\": null,\r\n \"resultDetails\": {},\r\n \"internalResultDetails\": {}\r\n },\r\n \"admin\": {\r\n \"userName\": null,\r\n \"password\": null\r\n }\r\n },\r\n \"readCredentialResponse\": {\r\n \"state\": {\r\n \"result\": \"Success\",\r\n \"reason\": null,\r\n \"resultDetails\": {},\r\n \"internalResultDetails\": {}\r\n },\r\n \"snmpV1V2Read\": {\r\n \"password\": \"password\"\r\n }\r\n },\r\n \"readWriteCredentialResponse\": {\r\n \"state\": {\r\n \"result\": \"Success\",\r\n \"reason\": null,\r\n \"resultDetails\": {},\r\n \"internalResultDetails\": {}\r\n },\r\n \"snmpV1V2ReadWrite\": {\r\n \"password\": null\r\n }\r\n },\r\n \"v3CredentialResponse\": {\r\n \"state\": {\r\n \"result\": \"NotTried\",\r\n \"reason\": null,\r\n \"resultDetails\": {},\r\n \"internalResultDetails\": {}\r\n },\r\n \"snmpV3\": {\r\n \"authenticationProtocol\": null,\r\n \"privacyProtocol\": null,\r\n \"authenticationPassword\": null,\r\n \"privacyPassword\": null,\r\n \"userName\": null,\r\n \"context\": null\r\n }\r\n }\r\n }" | |
| operationId: Credentials_VerifyCredentials | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/x-www-form-urlencoded | |
| produces: | |
| - application/json | |
| - text/json | |
| parameters: | |
| - name: deviceCredentialCollection | |
| in: body | |
| description: The set of credentials to attempt to verify | |
| required: true | |
| schema: | |
| $ref: '#/definitions/DeviceCredentialCollection' | |
| responses: | |
| '201': | |
| description: Success | |
| schema: | |
| format: 'null' | |
| type: string | |
| '400': | |
| description: 'Bad Request: Invalid or incomplete data was supplied to the API.' | |
| '401': | |
| description: >- | |
| Not Authenticated: Authentication within JAMC failed (invalid API | |
| key). | |
| '500': | |
| description: >- | |
| Internal Error: An issue not listed in the other response messages | |
| has caused an error. | |
| /api/credentialsCallback: | |
| post: | |
| tags: | |
| - CredentialsCallback | |
| summary: Registers a port and path for retrieving device credentials. | |
| description: " Registers a port and path for retrieving device credentials.\r\n \r\n If a callback API is registered for retrieving device credentials, then the connector will call that\r\n API first when attempting to communicate with a device. The API should return a list of valid credentials \r\n for the specified deviceId, as specified below.\r\n \r\n Request details:\r\n path: The API path to call on the localhost, to retrieve credentials for a specified device\r\n port: The port on the localhost, where the API path is exposed\r\n \r\n Sample request:\r\n {\r\n \"Path\": \"/api/credentials\",\r\n \"Port\": 11111\r\n }\r\n \r\n The API will be called with a POST request with an array containing a single device, like this:\r\n [\r\n \"DeviceIdentifier\": {\r\n \"Addressing\": {\r\n \"HostName\": \"host1.auth.hpicorp.net\",\r\n \"IPAddress\": \"1.2.3.4\"\r\n },\r\n \"DeviceCredentials\": null,\r\n \"DeviceIdentity\": {\r\n \"DeviceId\": 8,\r\n \"ModelName\": \"HP COLOR LASERJET MFP\",\r\n \"SerialNumber\": \"12345678\"\r\n }\r\n }\r\n ]\r\n \r\n The API should respond with the same structure in \"results\", containing all the necessary credentials, like this:\r\n {\r\n \"Results\": [\r\n {\r\n \"Addressing\": {\r\n \"HostName\": \"host1.auth.hpicorp.net (string - optional)\",\r\n \"IPAddress\": \"1.2.3.4\"\r\n },\r\n \"DeviceCredentials\": {\r\n \"Admin\": {\r\n \"UserName\": \"admin\",\r\n \"Password\": \"string\"\r\n },\r\n \"SnmpV1V2Read\": {\r\n \"Password\": \"public (string)\"\r\n },\r\n \"SnmpV1V2ReadWrite\": {\r\n \"Password\": \"string\"\r\n },\r\n \"SnmpV3\": {\r\n \"AuthenticationProtocol\": \"SHA1/MD5/SHA\",\r\n \"AuthenticationPassword\": \"string\",\r\n \"PrivacyProtocol\": \"DES/AES/AES128\",\r\n \"PrivacyPassword\": \"string\",\r\n \"UserName\": \"string\",\r\n \"Context\": \"Jetdirect\"\r\n }\r\n },\r\n \"DeviceIdentity\": {\r\n \"DeviceId\": 8,\r\n \"ModelName\": \"HP COLOR LASERJET MFP XYZ (string - optional)\",\r\n \"SerialNumber\": \"12345678 (string - optional)\"\r\n }\r\n }\r\n ]\r\n}\r\n \r\n Note that any credential specified as null will instruct the connector to use default values." | |
| operationId: CredentialsCallback_Post | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/x-www-form-urlencoded | |
| produces: [] | |
| parameters: | |
| - name: credentialsCallback | |
| in: body | |
| description: The port and path | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CredentialsCallback' | |
| responses: | |
| '204': | |
| description: Success | |
| '400': | |
| description: 'Bad Request: Invalid or incomplete data was supplied to the API.' | |
| '401': | |
| description: >- | |
| Not Authenticated: Authentication within JAMC failed (invalid API | |
| Key). | |
| '500': | |
| description: >- | |
| Internal Error: An issue not listed in the other response messages | |
| has caused an error. | |
| /api/customerPreferences: | |
| put: | |
| tags: | |
| - CustomerPreferences | |
| summary: Update Customer preference settings | |
| description: "Update Customer preferences with the specified details. Any fields sent in the request will be updated, and fields\r\nthat are not included will not be modified.\r\n\r\nOptional Field Descriptions:\r\n ManageAMV: Whether or not customer is allowed to manage multi-vendor (AMV) devices (boolean, must be enabled for SP first)\r\n EnableAutomaticConnectorUpdates: Whether or not customer connectors will update automatically (boolean)\r\n ApprovedConnectorVersion: If EnableAutomaticConnectorUpdates is true, this allows customers to specify which version has been\r\n qualified for auto update. If not specified, connectors will update to the latest version. The available versions\r\n can be found using the UpgradeVersions API.\r\n EnableRemoteEws: Whether or not the customer wants remote EWS management of customer devices (boolean)\r\n EnableDeviceAnnouncement: Whether customer wants Device Announcement (Network or USB direct connect)\r\n DnsPreferred: Whether or not a customer with Device Announcement enabled prefers to use DNS to Resolve configuration server\r\n AutoTelemetryCollection: Telemetry data collections for the customer fleet\r\n \"Enabled\": true/false, \r\n \"Interval\": \"dd.hh:mm\"\r\n AutoConsumablesUsageCollection: OCV/Supplies/Usage data collections for the customer fleet\r\n \"Enabled\": true/false, \r\n \"Interval\": \"dd.hh:mm\"\r\n \r\nSample request:\r\n {\r\n \"EnableAutomaticConnectorUpdates\": true,\r\n \"EnableRemoteEws\": false,\r\n \"EnableDeviceAnnouncement\": true,\r\n \"DnsPreferred\": true,\r\n \"AutoConsumablesUsageCollection\": {\r\n “Enabled”: true,\r\n “Interval”: “02.00:00”\r\n }\r\n }" | |
| operationId: CustomerPreferences_Put | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/x-www-form-urlencoded | |
| produces: [] | |
| parameters: | |
| - name: customerPreferences | |
| in: body | |
| description: The list of preferences to update (required) | |
| required: true | |
| schema: | |
| type: object | |
| additionalProperties: | |
| type: object | |
| responses: | |
| '204': | |
| description: Success | |
| '400': | |
| description: 'Bad Request: Invalid or incomplete data was supplied to the API.' | |
| '401': | |
| description: >- | |
| Not Authenticated: Authentication within JAMC failed (invalid API | |
| Key). | |
| '500': | |
| description: >- | |
| Internal Error: An issue not listed in the other response messages | |
| has caused an error. | |
| /api/deviceConfigData: | |
| post: | |
| tags: | |
| - DeviceConfigData | |
| summary: Retrieves config item data from a device. | |
| description: "Retrieves config item data from a device. This operation may take some time since it attempts to communicate with the device.\r\n\r\nRequired request field descriptions:\r\n deviceIdentifier: Use the Addressing portion to specify the IPAddress (IPv4), IPv6Address (IPv6), or Hostname of the desired device.\r\n If included, the IPAddress must not be a v6 address, and the IPv6Address must be a valid v6 address.\r\n configItems: Specify one or more config items to retrieve. Some possible values are these (may not be complete):\r\n - CountTotals: Overall totals for major page count values, such as total/mono/color\r\n - CountDetails: More detailed results such as counts per media size\r\n - Supplies: Cartridge information such as levels\r\n - Coverage: More detailed page coverage information, if supported and authorized\r\n - VerifyAdmin: Verifies that the specified Admin/EWS password is correct for the specified device\r\n - VerifySnmpV1V2Read: Verifies that the specified SNMPv1v2Read password is correct for the specified device\r\n - VerifySnmpV1V2ReadWrite: Verifies that the specified SNMPv1v2ReadWrite password is correct for the specified device\r\n - VerifySnmpV3: Verifies that the specified SNMPv3 password is correct for the specified device\r\n\r\nResponse field descriptions (Some internal or unused fields omitted for brevity):\r\n deviceIdentifier: Details about the device\r\n addressing: Device address info\r\n hostName: Device hostname\r\n ipAddress: Device IPv4 Address\r\n ipv6Address: Device IPv6 Address\r\n deviceCredentials: Internal - null\r\n deviceIdentity: Device ID info\r\n deviceId: The Device ID\r\n modelName: Device model name\r\n serialNumber: Device serial number\r\n configItems: List of returned config items\r\n name: Config item name\r\n value: Config item value (format varies by type, can be list of sub-item details if complex)\r\n name: Sub-item name\r\n value: Sub-item value\r\n valueType: Sub-item value type (Double, String, Complex, etc.)\r\n valueType: Config item value type\r\n state: Response from the data collection operation for this config item\r\n result: Operation result for this config item (Success, Failure)\r\n reason: Detailed reason for the result (many possible values...see HP developer documentation for details)\r\n state: Overall device result for the data collection operation\r\n result: Overall device result\r\n reason: Overall device result reason code\r\n ocvStatus: Device Genuine HP cartridge status (see DeviceList API for detailed values)\r\n\r\nSample request (for CountTotals):\r\n [\r\n {\r\n \"deviceIdentifier\": {\r\n \"addressing\": {\r\n \"hostName\": \"host1.auth.hpicorp.net\",\r\n \"ipAddress\": \"1.2.3.4\"\r\n }\r\n },\r\n \"configItems\": [\r\n {\r\n \"name\": \"CountTotals\"\r\n }\r\n ]\r\n }\r\n ]\r\n\r\nSample response (for CountTotals...some items omitted for brevity):\r\n {\r\n \"results\": [\r\n {\r\n \"deviceIdentifier\": {\r\n \"addressing\": {\r\n \"hostName\": \"host1.auth.hpicorp.net\",\r\n \"ipAddress\": \"1.2.3.4\",\r\n \"ipv6Address\": \"1:2:3:4:5:6:7:8\",\r\n \"useHostName\": false,\r\n \"verifiedHostName\": null\r\n },\r\n \"deviceCredentials\": null,\r\n \"deviceIdentity\": {\r\n \"deviceId\": 8,\r\n \"modelName\": \"HP COLOR LASERJET MFP\",\r\n \"serialNumber\": \"12345678\",\r\n \"state\": null\r\n }\r\n },\r\n \"configItems\": [\r\n {\r\n \"name\": \"CountTotals\",\r\n \"value\": [\r\n {\r\n \"name\": \"TotalImpressionsCounts\",\r\n \"value\": [\r\n {\r\n \"name\": \"ImpressionsTotalImpressions\",\r\n \"value\": 2143.0,\r\n \"valueType\": \"Double\",\r\n \"operation\": 0,\r\n \"diagnostic\": null\r\n },\r\n {\r\n \"name\": \"ImpressionsMonochromeImpressions\",\r\n \"value\": 42.0,\r\n \"valueType\": \"Double\",\r\n \"operation\": 0,\r\n \"diagnostic\": null\r\n },\r\n {\r\n \"name\": \"ImpressionsColorImpressions\",\r\n \"value\": 2101.0,\r\n \"valueType\": \"Double\",\r\n \"operation\": 0,\r\n \"diagnostic\": null\r\n }\r\n ],\r\n \"valueType\": \"McoSet\",\r\n \"operation\": 0,\r\n \"diagnostic\": null\r\n }\r\n ],\r\n \"valueType\": \"Complex\",\r\n \"state\": {\r\n \"result\": \"Success\",\r\n \"reason\": \"Applied\"\r\n },\r\n \"operation\": 0,\r\n \"diagnostic\": null\r\n }\r\n ],\r\n \"state\": {\r\n \"result\": \"Success\",\r\n \"reason\": \"Applied\"\r\n },\r\n \"performanceMetrics\": null,\r\n \"ocvStatus\": \"GenuineHP\"\r\n }\r\n ]\r\n }" | |
| operationId: DeviceConfigData_PostAsync | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/x-www-form-urlencoded | |
| produces: | |
| - application/json | |
| - text/json | |
| parameters: | |
| - name: deviceRequests | |
| in: body | |
| description: The devices and config items to retrieve | |
| required: true | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/DeviceRequest' | |
| responses: | |
| '201': | |
| description: Success | |
| schema: | |
| format: 'null' | |
| type: string | |
| '400': | |
| description: 'Bad Request: Invalid or incomplete data was supplied to the API.' | |
| '401': | |
| description: >- | |
| Not Authenticated: Authentication within JAMC failed (invalid API | |
| key). | |
| '500': | |
| description: >- | |
| Internal Error: An issue not listed in the other response messages | |
| has caused an error. | |
| /api/devices: | |
| get: | |
| tags: | |
| - DeviceList | |
| summary: Retrieves a list of device details. | |
| description: "Retrieves a list of device details.\r\n\r\nDevice Field descriptions:\r\n localDeviceId: Local Device ID on this connector, which is different than the standard device ID and should not be used. (integer)\r\n localCredentials: Whether or not local device-specific credentials have been entered (boolean)\r\n hostName: The Device hostname on the network (string)\r\n ipAddress: The Device IP address on the network (string)\r\n modelName: The model name of the device. This item is read-only and cannot be changed. (string)\r\n serialNumber: The serial number of the device (string)\r\n macAddress: The machine address of the device (string)\r\n isMsku: Whether or not the device is an HP Managed Device (boolean)\r\n mskuLicenseResult: Result of the last Managed Device Authorization attempt, if applicable (string)\r\n mskuExpiration: Managed Device authorization expiration date, if applicable (date string)\r\n mskuLicenseTimestamp: When the last Managed Device Authorization attempt was made (date string)\r\n eliteLicenseResult: Result of the last Enhanced Access Authorization attempt, if applicable (string)\r\n eliteLicenseExpiration: Enhanced Access Authorization expiration date, if applicable (date string)\r\n eliteLicenseTimestamp: When the last Enhanced Access Authorization attempt was made (date string)\r\n enhancedTelemetryDataLicenseResult: Result of the last Enhanced Telemetry Authorization attempt, if applicable (string)\r\n enhancedTelemetryDataLicenseExpiration: Enhanced Telemetry Authorization expiration date, if applicable (date string)\r\n enhancedTelemetryDataLicenseTimestamp: When the last Enhanced Access Authorization attempt was made (date string)\r\n enhancedServiceMessagingLicenseResult: Result of the last Enhanced Service Messaging attempt, if applicable (string)\r\n enhancedServiceMessagingLicenseExpiration: Enhanced Service Messaging expiration date, if applicable (date string)\r\n enhancedServiceMessagingLicenseTimestamp: When the last Enhanced Service Messaging attempt was made (date string)\r\n dataCollectionResult: Result of the last Data Collection attempt, if applicable (string)\r\n dataCollectionTimestamp: When the last Data Collection attempt was made (date string)\r\n dataCollectionLastSuccess: When the last successful Data Collection attempt was made (date string)\r\n lastCommTime: Date of last known successful communication between JAM and the device. This item is read-only. (string)\r\n isAmvDevice: Indicates whether a device is considered an HP Device or a Multi-vendor Device.\r\n ocvStatus:\r\n Unknown = Have not gotten a valid response yet, possibly due to errors\r\n GenuineHP = Verified Genuine HP cartridges\r\n NonHPCartridgeInstalled = Non-HP cartridge installed\r\n CartridgeInBadState = Cartridge may be invalid or damaged\r\n UsedCartridgeInstalled = Used cartridge installed\r\n NotSupported = Genuine HP verification not supported\r\n NotAttempted = Have not tried to verify yet\r\n \r\nSample Response:\r\n {\r\n \"Results\": [\r\n {\r\n \"localDeviceId\": 1,\r\n \"localCredentials\": false,\r\n \"hostName\": \"host1.hpicorp.net\",\r\n \"ipAddress\": \"1.2.3.4\",\r\n \"modelName\": \"HP LASERJET\",\r\n \"serialNumber\": \"12345678\",\r\n \"macAddress\": \"A0A0A0A0A0A0\",\r\n \"ocvStatus\": \"GenuineHP\",\r\n \"isMsku\": true,\r\n \"mskuLicenseResult\": \"Success\",\r\n \"mskuExpiration\": \"2017-04-23T00:00:00-06:00\",\r\n \"mskuLicenseTimestamp\": \"2017-03-29T21:37:21-06:00\",\r\n \"eliteLicenseResult\": \"HttpCredentialsNeeded\",\r\n \"eliteLicenseExpiration\": null,\r\n \"eliteLicenseTimestamp\": \"2017-03-29T21:40:13-06:00\",\r\n \"enhancedTelemetryDataLicenseResult\": null,\r\n \"enhancedTelemetryDataLicenseExpiration\": null,\r\n \"enhancedTelemetryDataLicenseTimestamp\": null,\r\n \"enhancedServiceMessagingLicenseResult\": null,\r\n \"enhancedServiceMessagingLicenseExpiration\": null,\r\n \"enhancedServiceMessagingLicenseTimestamp\": null,\r\n \"dataCollectionResult\": null,\r\n \"dataCollectionTimestamp\": null,\r\n \"dataCollectionLastSuccess\": null,\r\n \"lastCommTime\": \"2017-03-29T21:22:56-06:00\",\r\n \"isAmvDevice\": false\r\n }\r\n ]\r\n }\r\n \r\n Additional details about possible result string values and meanings can be found on the HP Developers portal." | |
| operationId: DeviceList_Get | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| responses: | |
| '200': | |
| description: Success | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/Device' | |
| /api/devices/invalidSerialNumbers: | |
| get: | |
| tags: | |
| - DeviceList | |
| summary: Retrieves list of devices with invalid serial numbers | |
| description: "Retrieves list of devices with invalid serial numbers.\r\n\r\nCurrent Field descriptions:\r\n InvalidDeviceId: The Invalid Device ID (different than a normal Device ID). (integer)\r\n HostName: The Device hostname on the network (string)\r\n IPAddress: The Device IP address on the network (string)\r\n ModelName: The model name of the device. (string)\r\n SerialNumber: The serial number of the device (string)\r\n LastContactTime: Date of last contact between JAM and the invalid device. (string) \r\n MacAddress: The machine address of the device (string)\r\n\r\nSample Response:\r\n {\r\n \"Results\": [\r\n {\r\n \"InvalidDeviceId \": 1,\r\n \"HostName\": \"host123.hp.com\",\r\n \"IPAddress\": \"1.2.3.4\",\r\n \"ModelName\": \"HP COLOR LASERJET\",\r\n \"SerialNumber\": \"12345678\",\r\n \"MacAddress\": \"112233445566\",\r\n \"LastContactTime\": \"2017-08-31T23:36:44.562Z\"\r\n }\r\n ]\r\n }" | |
| operationId: DeviceList_GetInvalidDevices | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| responses: | |
| '200': | |
| description: Success | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/ProxyInvalidDevice' | |
| '401': | |
| description: 'Not Authenticated: Authentication within JAM failed (invalid user).' | |
| '404': | |
| description: 'Not Found: Invalid Connector ID' | |
| '500': | |
| description: >- | |
| Internal Error: An issue not listed in the other response messages | |
| has caused an error. | |
| /api/deviceNotificationCallback: | |
| post: | |
| tags: | |
| - DeviceNotificationCallback | |
| summary: Registers a port and path for receiving device change notifications | |
| description: "Registers a port and path for receiving device change notifications.\r\n \r\nIf a callback API is registered for receiving device change notifications, then the connector will call that\r\nAPI with a POST request whenever the device status changes (deleted, new addressing, etc.). The call may include \r\none or more devices in a list.\r\n\r\nRequest details:\r\n path: The API path to call on the localhost, to notify about device changes\r\n port: The port on the localhost, where the API path is exposed\r\n \r\nSample request:\r\n {\r\n \"path\": \"/api/deviceChange\",\r\n \"port\": 11111\r\n }\r\n \r\nAPI request field descriptions:\r\n Addressing: Updated device address information\r\n DeviceIdentity: Device identification information\r\n IsActiveDevice: Whether or not the device is currently active (boolean)\r\n \r\nSample callback content (after deleting a device):\r\n [\r\n {\r\n \"Addressing\": {\r\n \"HostName\": \"deviceHostname.MyCompany.com\",\r\n \"IPAddress\": \"16.44.34.333\"\r\n },\r\n \"DeviceIdentity\": {\r\n \"DeviceId\": 1,\r\n \"ModelName\": \"HP COLOR LASERJET 4700\",\r\n \"SerialNumber\": \"JP8LD15958\"\r\n },\r\n \"IsActiveDevice\": false\r\n }\r\n ]" | |
| operationId: DeviceNotificationCallback_Post | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/x-www-form-urlencoded | |
| produces: [] | |
| parameters: | |
| - name: deviceNotificationCallback | |
| in: body | |
| description: The port and path | |
| required: true | |
| schema: | |
| $ref: '#/definitions/DeviceNotificationCallback' | |
| responses: | |
| '204': | |
| description: Success | |
| '400': | |
| description: 'Bad Request: Invalid or incomplete data was supplied to the API.' | |
| '401': | |
| description: >- | |
| Not Authenticated: Authentication within JAMC failed (invalid API | |
| Key). | |
| '500': | |
| description: >- | |
| Internal Error: An issue not listed in the other response messages | |
| has caused an error. | |
| /api/diagnostics: | |
| get: | |
| tags: | |
| - Diagnostics | |
| summary: Retrieves a list of diagnostic test names. | |
| description: "Retrieves a list of diagnostic test names.\r\nThese tests can be called individually to determine the connector status.\r\n\r\nCurrent test names are as follows, although it may be subject to change:\r\n ConfigurationTest: Validates configuration settings\r\n ConnectionTest: Validates connectivity to the cloud\r\n RegistrationTest: Validates registration status\r\n \r\nSample response:\r\n {\r\n \"tests\": [\r\n \"ConfigurationTest\",\r\n \"ConnectionTest\",\r\n \"RegistrationTest\"\r\n ]\r\n }" | |
| operationId: Diagnostics_Get | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| responses: | |
| '200': | |
| description: Success | |
| schema: | |
| $ref: '#/definitions/DiagnosticsTests' | |
| '/api/diagnostics/{testName}': | |
| get: | |
| tags: | |
| - Diagnostics | |
| summary: Runs and returns the results for a specific connector diagnostic test | |
| description: "Runs and returns the results for a specific connector diagnostic test\r\nThe list of possible test names is retrieved using the GET API with no parameter.\r\n\r\nResponse field descriptions:\r\n name: Name of the test (string)\r\n result: Result of the test (string)\r\n - OK: test passed\r\n - Warning: test failed but non-critical error\r\n - Error: test failed\r\n action: Reason for failure, indicating potential actions to resolve the issue (string)\r\n \r\nPossible values for 'action':\r\n - ErrorSignaling: Non-critical signaling service problem. Try restarting service or computer.\r\n - ErrorMissingConfigFile: Config file missing, restart service.\r\n - ErrorOpeningConfigFile: Error reading config file, rename and restart service, or restart computer.\r\n - ErrorNoInternet: Verify network connectivity.\r\n - ErrorWebProxySettings: Verify network connectivity, enter correct custom or default proxy settings, or try alternate proxy.\r\n - ErrorFirewallPorts: Verify network connectivity, or contact an admin.\r\n - ErrorCertificateValidation: Contact an admin.\r\n - ErrorNoJAMResponse: Wait and try again later, or contact an admin.\r\n - ErrorMissingRegKey: Obtain a new registration key and apply it.\r\n \r\nSample response:\r\n {\r\n \"name\": \"ConfigurationTest\",\r\n \"result\": \"OK\",\r\n \"action\": null\r\n }" | |
| operationId: Diagnostics_Get | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| parameters: | |
| - name: testName | |
| in: path | |
| description: The name of the test to be run. | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: Success | |
| schema: | |
| $ref: '#/definitions/DiagnosticsResult' | |
| '404': | |
| description: 'Not Found: Invalid test name' | |
| '500': | |
| description: >- | |
| Internal Error: An issue not listed in the other response messages | |
| has caused an error. | |
| /api/firmware: | |
| get: | |
| tags: | |
| - Firmware | |
| summary: '' | |
| operationId: Firmware_GetAsync | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| parameters: | |
| - name: fileName | |
| in: query | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: object | |
| /ping: | |
| get: | |
| tags: | |
| - HealthCheck | |
| summary: '' | |
| operationId: HealthCheck_Ping | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: object | |
| /health: | |
| get: | |
| tags: | |
| - HealthCheck | |
| summary: '' | |
| operationId: HealthCheck_Health | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: object | |
| /api/queueUpgradeConnector: | |
| post: | |
| tags: | |
| - QueueUpgradeConnector | |
| summary: Upgrade a connector to a specified version | |
| description: "Upgrade a connector to a specified version. Use the UpgradeVersions API to determine which versions can be specified.\r\n\r\nField Descriptions:\r\n version: Which version to upgrade to (string, must match a version from UpgradeVersions API)\r\n \r\nSample request:\r\n {\r\n \"version\": \"4.1.2000\"\r\n }" | |
| operationId: QueueUpgradeConnector_Post | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/x-www-form-urlencoded | |
| produces: | |
| - application/json | |
| - text/json | |
| parameters: | |
| - name: data | |
| in: body | |
| description: The version string (required) | |
| required: true | |
| schema: | |
| $ref: '#/definitions/QueueUpgradeConnectorData' | |
| responses: | |
| '204': | |
| description: Success | |
| schema: | |
| type: object | |
| '400': | |
| description: 'Bad Request: Invalid or incomplete data was supplied to the API.' | |
| '401': | |
| description: >- | |
| Not Authenticated: Authentication within JAMC failed (invalid API | |
| Key). | |
| '500': | |
| description: >- | |
| Internal Error: An issue not listed in the other response messages | |
| has caused an error. | |
| /api/settings: | |
| get: | |
| tags: | |
| - Settings | |
| summary: Retrieves a list of connector settings | |
| description: "Retrieves a list of connector settings\r\n\r\nResult field descriptions:\r\n registrationKey: Key used to register with JetAdvantage Management cloud (string)\r\n firstName: Contact info first name (string)\r\n lastName: Contact info last name (string)\r\n email: Contact info email (string)\r\n phone: Contact info phone (string)\r\n notes: Location or other info pertaining to this connector (string)\r\n useProxy: Whether or not a web proxy is required for communication (boolean)\r\n proxyHost: Web proxy hostname (string)\r\n proxyPort: Web proxy port (nullable integer)\r\n useProxyCredentials: Whether or not web proxy credentials are required (boolean)\r\n proxyUserName: Web proxy user name (string)\r\n proxyPassword: Web proxy password (string)\r\n isvApiKey: Key used if a connector makes calls to the ISV callback API's (string)\r\n version: Connector version (string)\r\n connectorGuid: Connector identification GUID (string)\r\n connectorId: Connector ID (string)\r\n apiKey: Key to use when making subsequent Connector API calls after registration (string)\r\n \r\nSample response:\r\n {\r\n \"registrationKey\": \"53c17fd3-5b8c-4bfd-8ba1-7e5c5a14b643\",\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Contact\",\r\n \"email\": \"[email protected]\",\r\n \"phone\": \"111-111-1111\",\r\n \"notes\": \"Test installation info\",\r\n \"useProxy\": false,\r\n \"proxyHost\": null,\r\n \"proxyPort\": null,\r\n \"useProxyCredentials\": false,\r\n \"proxyUserName\": null,\r\n \"proxyPassword\": null,\r\n \"isvApiKey\": null,\r\n \"version\": \"4.1.99999\",\r\n \"connectorGuid\": \"d10128e7-0cd1-4ef5-abc9-01125b433789\",\r\n \"connectorId\": \"1\",\r\n \"apiKey\": null\r\n }" | |
| operationId: Settings_Get | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| responses: | |
| '200': | |
| description: Success | |
| schema: | |
| $ref: '#/definitions/Settings' | |
| post: | |
| tags: | |
| - Settings | |
| summary: Registers a non-ISV connector or updates other connector settings | |
| description: "Registers a non-ISV connector or updates other connector settings\r\nThis method should not be used to register ISV connectors, which require local ISV tool API communications.\r\nIf the connector is not already registered and a new registration key is provided, this\r\nwill attempt to register a connector with JetAdvantage Management cloud.\r\nIf the connector is already registered, the registration key will be ignored.\r\n\r\nNOTE: Any field omitted from the request will be set to null/empty, so it is recommended to include all fields even\r\n if updating just some of them. Invalid or partial data sent in the request may cause unexpected results.\r\n This call could also take a very long time to complete depending on network traffic.\r\n It is advised to up the timeout to 5 minutes when calling this API.\r\n\r\nRequired Fields:\r\n registrationKey: Only required if not currently registered. Used to register with JetAdvantage Management cloud (string)\r\n \r\nOptional Fields (will be erased or set to default values if omitted!):\r\n firstName: OBSOLETE - NOT USED.\r\n lastName: OBSOLETE - NOT USED.\r\n email: OBSOLETE - NOT USED.\r\n phone: OBSOLETE - NOT USED.\r\n notes: Location or other info pertaining to this connector (string)\r\n useProxy: Whether or not a web proxy is required for communication (boolean)\r\n proxyHost: Web proxy hostname (string)\r\n proxyPort: Web proxy port (nullable integer)\r\n useProxyCredentials: Whether or not web proxy credentials are required (boolean)\r\n proxyUserName: Web proxy user name (string)\r\n proxyPassword: Web proxy password (string)\r\n \r\nSample request:\r\n {\r\n \"registrationKey\": \"53c17fd3-5b8c-4bfd-8ba1-7e5c5a14b643\",\r\n \"notes\": \"Test installation info\",\r\n \"useProxy\": false,\r\n \"proxyHost\": null,\r\n \"proxyPort\": null,\r\n \"useProxyCredentials\": false,\r\n \"proxyUserName\": null,\r\n \"proxyPassword\": null\r\n }\r\n \r\nSample response:\r\n {\r\n \"registrationKey\": \"53c17fd3-5b8c-4bfd-8ba1-7e5c5a14b643\",\r\n \"notes\": \"Test installation info\",\r\n \"useProxy\": false,\r\n \"proxyHost\": null,\r\n \"proxyPort\": null,\r\n \"useProxyCredentials\": false,\r\n \"proxyUserName\": null,\r\n \"proxyPassword\": null,\r\n \"isvApiKey\": null,\r\n \"version\": \"4.1.99999\",\r\n \"connectorGuid\": \"d10128e7-0cd1-4ef5-abc9-01125b433789\",\r\n \"connectorId\": \"1\",\r\n \"apiKey\": null\r\n }" | |
| operationId: Settings_Post | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/x-www-form-urlencoded | |
| produces: | |
| - application/json | |
| - text/json | |
| parameters: | |
| - name: settings | |
| in: body | |
| description: The settings object containing the data to be written. | |
| required: true | |
| schema: | |
| $ref: '#/definitions/Settings' | |
| responses: | |
| '200': | |
| description: Success | |
| schema: | |
| $ref: '#/definitions/Settings' | |
| '400': | |
| description: >- | |
| Bad Request: Invalid or incomplete data was supplied to the API, or | |
| could not connect to cloud. | |
| '500': | |
| description: >- | |
| Internal Error: An issue not listed in the other response messages | |
| has caused an error. | |
| /api/settings/isv: | |
| post: | |
| tags: | |
| - Settings | |
| summary: Registers an ISV connector or updates other connector settings | |
| description: "Registers an ISV connector or updates other connector settings\r\nIf a new registration key is provided, this will attempt to register a connector with JetAdvantage Management cloud.\r\nThis method is used to register ISV connectors, which require local ISV tool API communications. It returns an ApiKey to\r\nuse in subsequent API calls.\r\n\r\nNOTE: Any field omitted from the request will be set to null/empty, so it is recommended to include all fields even\r\n if updating just some of them. This call could also take a very long time to complete depending on network traffic.\r\n It is advised to up the timeout to 5 minutes when calling this API.\r\n\r\nRequired Fields:\r\n registrationKey: Key used to register with JetAdvantage Management cloud (string)\r\n (must either provide the existing key, or a new key if registering)\r\n isvApiKey: Key used to register a connector for a specific ISV partner (string, 32-48 chars, alphanumeric).\r\n The isvApiKey will be included if the connector makes any API calls back to the ISV, so the ISV can validate the caller.\r\n \r\nOptional Fields (will be erased or set to default values if omitted!):\r\n firstName: Contact info first name (string)\r\n lastName: Contact info last name (string)\r\n email: Contact info email (string)\r\n phone: Contact info phone (string)\r\n notes: Location or other info pertaining to this connector (string)\r\n useProxy: Whether or not a web proxy is required for communication (boolean)\r\n proxyHost: Web proxy hostname (string)\r\n proxyPort: Web proxy port (nullable integer)\r\n useProxyCredentials: Whether or not web proxy credentials are required (boolean)\r\n proxyUserName: Web proxy user name (string)\r\n proxyPassword: Web proxy password (string)\r\n \r\nSample request:\r\n {\r\n \"registrationKey\": \"53c17fd3-5b8c-4bfd-8ba1-7e5c5a14b643\",\r\n \"isvApiKey\": \"1234567812341234123412345678ABCDEFG\",\r\n \"firstName\": \"NewFirst\",\r\n \"lastName\": \"NewLast\",\r\n \"email\": \"[email protected]\",\r\n \"phone\": \"111-111-1111\",\r\n \"notes\": \"Test installation info\",\r\n \"useProxy\": false,\r\n \"proxyHost\": null,\r\n \"proxyPort\": null,\r\n \"useProxyCredentials\": false,\r\n \"proxyUserName\": null,\r\n \"proxyPassword\": null\r\n }\r\n \r\nSample response:\r\n {\r\n \"registrationKey\": \"53c17fd3-5b8c-4bfd-8ba1-7e5c5a14b643\",\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Contact\",\r\n \"email\": \"[email protected]\",\r\n \"phone\": \"111-111-1111\",\r\n \"notes\": \"Test installation info\",\r\n \"useProxy\": false,\r\n \"proxyHost\": null,\r\n \"proxyPort\": null,\r\n \"useProxyCredentials\": false,\r\n \"proxyUserName\": null,\r\n \"proxyPassword\": null,\r\n \"isvApiKey\": \"1234567812341234123412345678ABCDEFG\",\r\n \"version\": \"4.1.99999\",\r\n \"connectorGuid\": \"d10128e7-0cd1-4ef5-abc9-01125b433789\",\r\n \"connectorId\": \"1\",\r\n \"apiKey\": null\r\n }\r\n \r\nThe apiKey returned should be used in subsequent API calls which require it." | |
| operationId: Settings_PostIsvAsync | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/x-www-form-urlencoded | |
| produces: | |
| - application/json | |
| - text/json | |
| parameters: | |
| - name: settings | |
| in: body | |
| description: The settings object containing the data to be written. | |
| required: true | |
| schema: | |
| $ref: '#/definitions/Settings' | |
| responses: | |
| '200': | |
| description: Success | |
| schema: | |
| $ref: '#/definitions/Settings' | |
| '400': | |
| description: >- | |
| Bad Request: Invalid or incomplete data was supplied to the API, or | |
| could not connect to cloud. | |
| '500': | |
| description: >- | |
| Internal Error: An issue not listed in the other response messages | |
| has caused an error. | |
| /api/state: | |
| get: | |
| tags: | |
| - State | |
| summary: Retrieves connector status and version information | |
| description: "Retrieves connector status and version information\r\nNote that if the connector service is not running, the API will return a response code of 0 with no content.\r\n\r\nResult field descriptions:\r\n status: Connector status (string)\r\n - OK: Connector is communicating normally\r\n - Initializing: Connector is initializing\r\n - NotRegistered: Connector is not registered\r\n - Registering: Connector is registering\r\n - CommunicationError: Connector cannot communicate with JetAdvantage Management cloud\r\n - ServiceNotStarted: Connector service not started\r\n - InvalidRegistrationKey: Invalid registration key - obtain a new one\r\n - InvalidCertificate: Invalid certificate - contact an admin\r\n - CannotFetchCertificateRevocationList: Issue verifying certificate revocation list - wait, restart, or contact an admin\r\n version: Connector version (string)\r\n \r\nSample response:\r\n {\r\n \"status\": \"OK\",\r\n \"version\": \"4.1.99999\"\r\n }" | |
| operationId: State_Get | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| responses: | |
| '200': | |
| description: Success | |
| schema: | |
| $ref: '#/definitions/State' | |
| /api/upgradeVersions: | |
| get: | |
| tags: | |
| - UpgradeVersions | |
| summary: Retrieve the available connector upgrade versions. | |
| description: "Retrieve the available connector upgrade versions. These versions are the possible values that can be specified, either when initiating\r\na connector upgrade operation (queueUpgradeConnector) or specifying an approved connector version (customerPreferences).\r\nIf multiple versions are returned, there is no guarantee as to the order.\r\n\r\nSample response:\r\n {\r\n \"results\" [\r\n {\r\n \"version\": \"4.1.1000\"\r\n },\r\n {\r\n \"version\": \"4.2.2000\"\r\n }\r\n ]\r\n }" | |
| operationId: UpgradeVersions_Get | |
| consumes: [] | |
| produces: | |
| - application/json | |
| - text/json | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/EnumerableResults[UpgradeVersion]' | |
| /api/workrequestor: | |
| post: | |
| tags: | |
| - WorkRequestor | |
| summary: '' | |
| operationId: WorkRequestor_RequestAskForWork | |
| consumes: | |
| - application/json | |
| - text/json | |
| - application/x-www-form-urlencoded | |
| produces: | |
| - application/json | |
| - text/json | |
| parameters: | |
| - name: message | |
| in: body | |
| required: true | |
| schema: | |
| $ref: '#/definitions/AskForWorkMessage' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: object | |
| definitions: | |
| DeviceCredentials: | |
| type: object | |
| properties: | |
| admin: | |
| $ref: '#/definitions/AdminCredentials' | |
| snmpV1V2Read: | |
| $ref: '#/definitions/SnmpV1V2Read' | |
| snmpV1V2ReadWrite: | |
| $ref: '#/definitions/SnmpV1V2ReadWrite' | |
| snmpV3: | |
| $ref: '#/definitions/SnmpV3' | |
| fileSystemPassword: | |
| $ref: '#/definitions/FileSystemPassword' | |
| pjlPassword: | |
| $ref: '#/definitions/PjlPassword' | |
| bootloaderPassword: | |
| $ref: '#/definitions/BootloaderPassword' | |
| oAuthCredentials: | |
| $ref: '#/definitions/OAuthCredentials' | |
| credType: | |
| format: int32 | |
| enum: | |
| - 0 | |
| - 1 | |
| - 2 | |
| - 3 | |
| type: integer | |
| readOnly: true | |
| AdminCredentials: | |
| type: object | |
| properties: | |
| userName: | |
| type: string | |
| password: | |
| type: string | |
| SnmpV1V2Read: | |
| type: object | |
| properties: | |
| password: | |
| type: string | |
| SnmpV1V2ReadWrite: | |
| type: object | |
| properties: | |
| password: | |
| type: string | |
| SnmpV3: | |
| type: object | |
| properties: | |
| authenticationProtocol: | |
| type: string | |
| privacyProtocol: | |
| type: string | |
| authenticationPassword: | |
| type: string | |
| privacyPassword: | |
| type: string | |
| userName: | |
| type: string | |
| context: | |
| type: string | |
| FileSystemPassword: | |
| type: object | |
| properties: | |
| password: | |
| type: string | |
| PjlPassword: | |
| type: object | |
| properties: | |
| password: | |
| type: string | |
| BootloaderPassword: | |
| type: object | |
| properties: | |
| password: | |
| type: string | |
| OAuthCredentials: | |
| type: object | |
| properties: | |
| token: | |
| type: string | |
| DeviceCredentialCollection: | |
| description: '' | |
| type: object | |
| properties: | |
| deviceIdentifier: | |
| $ref: '#/definitions/DeviceIdentifier' | |
| description: '' | |
| readOnly: true | |
| tryDefaultCredentials: | |
| description: '' | |
| type: boolean | |
| admin: | |
| description: '' | |
| type: array | |
| items: | |
| $ref: '#/definitions/AdminCredentials' | |
| readOnly: true | |
| snmpV1V2Read: | |
| description: '' | |
| type: array | |
| items: | |
| $ref: '#/definitions/SnmpV1V2Read' | |
| readOnly: true | |
| snmpV1V2ReadWrite: | |
| description: '' | |
| type: array | |
| items: | |
| $ref: '#/definitions/SnmpV1V2ReadWrite' | |
| readOnly: true | |
| snmpV3: | |
| description: '' | |
| type: array | |
| items: | |
| $ref: '#/definitions/SnmpV3' | |
| readOnly: true | |
| DeviceIdentifier: | |
| type: object | |
| properties: | |
| addressing: | |
| $ref: '#/definitions/Addressing' | |
| deviceCredentials: | |
| $ref: '#/definitions/DeviceCredentials' | |
| deviceIdentity: | |
| $ref: '#/definitions/DeviceIdentity' | |
| Addressing: | |
| type: object | |
| properties: | |
| hostName: | |
| type: string | |
| ipAddress: | |
| type: string | |
| iPv6Address: | |
| type: string | |
| useHostName: | |
| type: boolean | |
| addressingVerified: | |
| type: boolean | |
| verifiedHostName: | |
| type: string | |
| verifiedIPAddress: | |
| type: string | |
| verifiedIPv6Address: | |
| type: string | |
| address: | |
| type: string | |
| readOnly: true | |
| addressType: | |
| format: int32 | |
| enum: | |
| - 0 | |
| - 1 | |
| - 2 | |
| type: integer | |
| readOnly: true | |
| DeviceIdentity: | |
| type: object | |
| properties: | |
| deviceId: | |
| format: int64 | |
| type: integer | |
| modelName: | |
| type: string | |
| intrinsicId: | |
| type: string | |
| serialNumber: | |
| type: string | |
| state: | |
| type: string | |
| CredentialsCallback: | |
| description: '' | |
| type: object | |
| properties: | |
| path: | |
| description: '' | |
| type: string | |
| port: | |
| format: int32 | |
| description: '' | |
| type: integer | |
| DeviceRequest: | |
| type: object | |
| properties: | |
| configItems: | |
| type: array | |
| items: | |
| $ref: '#/definitions/ConfigItem' | |
| deviceIdentifier: | |
| $ref: '#/definitions/DeviceIdentifier' | |
| operation: | |
| type: string | |
| ConfigItem: | |
| type: object | |
| properties: | |
| permitSnap: | |
| type: boolean | |
| name: | |
| type: string | |
| operation: | |
| format: int32 | |
| enum: | |
| - 0 | |
| - 1 | |
| type: integer | |
| value: | |
| type: object | |
| valueType: | |
| type: string | |
| configItemType: | |
| type: string | |
| parameters: | |
| type: object | |
| additionalProperties: | |
| type: string | |
| readOnly: true | |
| Device: | |
| description: '' | |
| type: object | |
| properties: | |
| localDeviceId: | |
| format: int32 | |
| description: Device Id only seen in JAMC | |
| type: integer | |
| localCredentials: | |
| description: Flag for signaling if Local JAMC credentials are set or not. | |
| type: boolean | |
| hostName: | |
| description: '' | |
| type: string | |
| ipAddress: | |
| description: '' | |
| type: string | |
| iPv6Address: | |
| description: '' | |
| type: string | |
| modelName: | |
| description: '' | |
| type: string | |
| serialNumber: | |
| description: '' | |
| type: string | |
| macAddress: | |
| description: '' | |
| type: string | |
| ocvStatus: | |
| description: '' | |
| type: string | |
| isMsku: | |
| description: '' | |
| type: boolean | |
| mskuLicenseResult: | |
| description: '' | |
| type: string | |
| mskuExpiration: | |
| format: date-time | |
| description: '' | |
| type: string | |
| mskuLicenseTimestamp: | |
| format: date-time | |
| description: '' | |
| type: string | |
| eliteLicenseResult: | |
| description: '' | |
| type: string | |
| eliteLicenseExpiration: | |
| format: date-time | |
| description: '' | |
| type: string | |
| eliteLicenseTimestamp: | |
| format: date-time | |
| description: '' | |
| type: string | |
| enhancedTelemetryDataLicenseResult: | |
| description: '' | |
| type: string | |
| enhancedTelemetryDataLicenseExpiration: | |
| format: date-time | |
| description: '' | |
| type: string | |
| enhancedTelemetryDataLicenseTimestamp: | |
| format: date-time | |
| description: '' | |
| type: string | |
| enhancedServiceMessagingLicenseResult: | |
| description: '' | |
| type: string | |
| enhancedServiceMessagingLicenseExpiration: | |
| format: date-time | |
| description: '' | |
| type: string | |
| enhancedServiceMessagingLicenseTimestamp: | |
| format: date-time | |
| description: '' | |
| type: string | |
| dataCollectionResult: | |
| description: '' | |
| type: string | |
| dataCollectionTimestamp: | |
| format: date-time | |
| description: '' | |
| type: string | |
| dataCollectionLastSuccess: | |
| format: date-time | |
| description: '' | |
| type: string | |
| lastCommTime: | |
| format: date-time | |
| description: '' | |
| type: string | |
| isAmvDevice: | |
| description: '' | |
| type: boolean | |
| familyName: | |
| description: '' | |
| type: string | |
| ProxyInvalidDevice: | |
| type: object | |
| properties: | |
| invalidDeviceId: | |
| format: int32 | |
| type: integer | |
| serialNumber: | |
| type: string | |
| modelName: | |
| type: string | |
| ipAddress: | |
| type: string | |
| iPv6Address: | |
| type: string | |
| hostName: | |
| type: string | |
| macAddress: | |
| type: string | |
| lastContactTime: | |
| format: date-time | |
| type: string | |
| DeviceNotificationCallback: | |
| description: '' | |
| type: object | |
| properties: | |
| path: | |
| description: '' | |
| type: string | |
| port: | |
| format: int32 | |
| description: '' | |
| type: integer | |
| DiagnosticsTests: | |
| description: '' | |
| type: object | |
| properties: | |
| tests: | |
| description: '' | |
| type: array | |
| items: | |
| type: string | |
| readOnly: true | |
| DiagnosticsResult: | |
| description: '' | |
| type: object | |
| properties: | |
| name: | |
| description: '' | |
| type: string | |
| result: | |
| description: '' | |
| type: string | |
| action: | |
| description: '' | |
| type: string | |
| QueueUpgradeConnectorData: | |
| description: '' | |
| type: object | |
| properties: | |
| version: | |
| description: '' | |
| type: string | |
| originalVersion: | |
| description: '' | |
| type: string | |
| Settings: | |
| description: '' | |
| type: object | |
| properties: | |
| registrationKey: | |
| description: '' | |
| type: string | |
| notes: | |
| description: '' | |
| type: string | |
| useProxy: | |
| description: '' | |
| type: boolean | |
| proxyHost: | |
| description: '' | |
| type: string | |
| proxyPort: | |
| format: int32 | |
| description: '' | |
| type: integer | |
| useProxyCredentials: | |
| description: '' | |
| type: boolean | |
| proxyUserName: | |
| description: '' | |
| type: string | |
| proxyPassword: | |
| description: '' | |
| type: string | |
| isvApiKey: | |
| description: '' | |
| type: string | |
| version: | |
| description: '' | |
| type: string | |
| connectorGuid: | |
| description: '' | |
| type: string | |
| connectorId: | |
| description: '' | |
| type: string | |
| apiKey: | |
| description: '' | |
| type: string | |
| State: | |
| description: '' | |
| type: object | |
| properties: | |
| status: | |
| description: '' | |
| type: string | |
| version: | |
| description: '' | |
| type: string | |
| 'EnumerableResults[UpgradeVersion]': | |
| type: object | |
| properties: | |
| results: | |
| type: array | |
| items: | |
| $ref: '#/definitions/UpgradeVersion' | |
| UpgradeVersion: | |
| description: The connector upgrade version | |
| type: object | |
| properties: | |
| version: | |
| description: '' | |
| type: string | |
| AskForWorkMessage: | |
| description: '' | |
| type: object | |
| properties: | |
| transactionId: | |
| description: '' | |
| type: string |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment