2-5 Print status

Retrieve the print status

SVF Cloud WebAPI assigns an ID to each printing request. This ID is used for generating and identifying the action. Specify this ID to retrieve the print status.

Example 1. Endpoint URI

https://api.svfcloud.com/v1/actions/{actionId}

Example 2. HTTP method

GET

Example 3. Accept header for the HTTP request

application/json

Example 4. Parameters

Path parameter
Path parameter
Value
Required
Description
actionId
Action ID
Specify the ID of the action for retrieving the print status.
Request header
Header field
Value
Description
Authorization
Bearer {your access token}
Specify the access token retrieved via authentication.

Path parameter	Value	Required	Description
actionId	Action ID		Specify the ID of the action for retrieving the print status.

Header field	Value	Description
Authorization	Bearer {your access token}	Specify the access token retrieved via authentication.

Response

Code	Description
HTTP/1.1 200 OK	Indicates that the process was executed successfully.
HTTP/1.1 401 Unauthorized	Occurs if the authentication information is invalid.
HTTP/1.1 404 Not Found	Occurs if an action with the specified ID does not exist.
HTTP/1.1 429 Too many Requests	Occurs if the number of API calls exceeds the threshold. Execute again after the number of seconds passed for the value returned in "Retry-After" of the response header.

Example 5. Output example (JSON format)

{
  "artifact": {
    "id": "8149fed9-dadd-4678-af2d-da2ead6d656d",
    "name": "WingArc",
    "pages": 1,
    "path": "WingArc.pdf",
    "sourceType": "CSV",
    "workflowId": "e892d8a3-daf2-4f78-b02f-102c59f69f05"
  },
  "billings": [
    {
      "date": "2018-03-07T02:01:50.656Z",
      "idx": 1,
      "pages": 1,
      "payment": {
        "coupon": "ec38b3b7-0c79-11e8-a7ab-06de8bf5ad36",
        "date": "2018-03-07T02:01:50.656Z"
      },
      "plan": {
        "fixed": false,
        "id": "9e14438b-0c79-11e8-a7ab-06de8bf5ad36",
        "name": "S",
        "points": 10,
        "profile": "",
        "type": "DOWNLOAD"
      }, 
      "points": 10
    }
  ],
  "code": 0,
  "executedTime": "2018-03-07T02:01:48.623Z",
  "id": "e892d8a3-daf2-4f78-b02f-102c59f69f05",
  "profile": "",
  "reason": 0,
  "segment": "",
  "state": 2,
  "stateUpdated": "2018-03-07T02:01:50.656Z",
  "type": 4,
  "user": {
    "id": "xxxx@api.svfcloud.com",
    "name": "John Smith",
  }
}

Key	Content	Description
id	Action ID	The ID that identifies the action. An action ID is assigned to each printing request that is made.
type	Action type	Indicates the type of requested process. See "Action type" in "Appendix".
state	Status	Indicates the status of the process. See "Print status" in "Appendix".
stateUpdated	Status update date and time	The date and time at which the status was updated. This information is updated when a change in status is detected.
code	Error code	Indicates error details. See "Error code" in "Appendix".
executedTime	Execution time	The date and time at which the process was executed.
artifact	Artifact information	Information about the generated artifact.
user	User information	Information about the user who executed the process.
billings	Invoice information	Information about invoicing.
profile	Profile information	Information on the request source.

Any key items that are not included in the list are not currently used. They have been defined for future use.

The contents that can be retrieved differs depending on the process status.

In this section:

2-5 Print status

Retrieve the print status

Response

Search results