HP Indigo Integration Hub
HP Indigo Integration Hub

Composer Example Workflow

Composer Example Workflows

This page shows a series of examples of the API calls required to upload resources and compose output for various job types.

Links to examples:

"Simple Business Card" Example

This example is taken from the SDK Client Sample code execution.

In this example:

  1. VDP Template input Resource using simpleBusinessCard.hpd file
  2. Data input Resource using simpleBusinessCard.csv
    1. Comma delimiter (ascii 44)
  3. Imposition Template Resource using simpleBusinessCard.impp
  4. No use of assets Library
  5. Request for Sample output resource
    1. The output format is requested as JPEG
    2. Request to skip first row of the data file
    3. Request for non-imposed result – record 2 of page 1
    4. Use PDF name simpleBusinessCard.pdf in case there is marks set with PDF name in it
    5. Ask to have output file with the name simpleBusinessCard.jpg
  6. Request for PDF output resource
    1. Request to skip first row of the data file
    2. Request to apply imposition
    3. Ask to have output file with the name mosaicNotebook.pdf
    4. Request for range of records 5 to 10 (included)

VDP Input Template Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template

Request Payload

{
	"fileName": "simpleBusinessCard.hpd"
}

Response Payload

{
	"fileName": "simpleBusinessCard.hpd",
	"output": {
		"richTemplate": false,
		"embeddedImpositionExist": false,
		"numberOfPages": 0,
		"resourceId": "3592edaa-a2d7-4b14-b2e6-43682576ad9e",
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558358742636,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558272342636
	}
}

Upload Template File

Request Upload PUT URLs

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/put-urls

Request Payload

{
	"resourceId": "3592edaa-a2d7-4b14-b2e6-43682576ad9e",
	"resourceType": "Template",
	"fileSize": 1969150,
	"partSize": 5242880
}

Response Payload

{
	"presignedUploadUrls": [
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		}
	]
}

Parts Upload Completion

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/parts

Request Payload

{
	"uploadPartInfos": [
		{
			"eTag": "91447733c57e382c616235b6d03efe83",
			"partNumber": 1
		}
	],
	"resourceId": "3592edaa-a2d7-4b14-b2e6-43682576ad9e",
	"resourceType": "Template"
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/3592edaa-a2d7-4b14-b2e6-43682576ad9e

Response Payload

{
	"fileName": "simpleBusinessCard.hpd",
	"output": {
		"richTemplate": false,
		"embeddedImpositionExist": true,
		"numberOfPages": 2,
		"resourceId": "3592edaa-a2d7-4b14-b2e6-43682576ad9e",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558877159333,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558272348009,
		"startProcessingTime": 1558272352639,
		"endProcessingTime": 1558272359333,
		"resourceCreationTime": 1558272342636
	}
}

Data Input Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data

Request Payload

{
	"dataFormatDelimiter": 44,
	"fileName": "simpleBusinessCard.csv"
}

Response Payload

{
	"output": {
		"resourceId": "e314708e-af15-4b90-9422-e1128edb0f4f",
		"numberOfRecords": 0,
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558358761292,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558272361292
	},
	"dataFormatDelimiter": 44,
	"fileName": "simpleBusinessCard.csv"
}

Upload File

Request Upload URLs

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/put-urls

Request Payload

{
	"resourceId": "e314708e-af15-4b90-9422-e1128edb0f4f",
	"resourceType": "Data",
	"fileSize": 150251,
	"partSize": 5242880
}

Response Payload

{
	"presignedUploadUrls": [
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		}
	]
}

Parts Upload Completion

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/parts

Request Payload

{
	"uploadPartInfos": [
		{
			"eTag": "d2ab3801ddeeaf019549389e0760d9d2",
			"partNumber": 1
		}
	],
	"resourceId": "e314708e-af15-4b90-9422-e1128edb0f4f",
	"resourceType": "Data"
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/e314708e-af15-4b90-9422-e1128edb0f4f

Response Payload

{
	"output": {
		"resourceId": "e314708e-af15-4b90-9422-e1128edb0f4f",
		"numberOfRecords": 1001,
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558877167901,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558272365495,
		"startProcessingTime": 1558272367589,
		"endProcessingTime": 1558272367901,
		"resourceCreationTime": 1558272361292
	},
	"dataFormatDelimiter": 44,
	"fileName": "simpleBusinessCard.csv"
}

Imposition Templates Input Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/imposition

Request Payload

{
	"fileName": "simpleBusinessCard.impp"
}

Response Payload

{
	"output": {
		"resourceId": "6ad498d1-c82b-49bb-a524-821cd8a6b68a",
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558358778787,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558272378787
	},
	"fileName": "simpleBusinessCard.impp"
}

Upload File

Request Upload URLs

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/put-urls

Request Payload

{
	"resourceId": "6ad498d1-c82b-49bb-a524-821cd8a6b68a",
	"resourceType": "ImpositionTemplate",
	"fileSize": 3358,
	"partSize": 5242880
}

Response Payload

{
  "presignedUploadUrls" : [ {
    "presignedUrl" : "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
  } ]
}

Parts Upload Completion

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/parts

Request Payload

{
	"uploadPartInfos": [
		{
			"eTag": "73b6027df959ff002aae9a4e98a2e538",
			"partNumber": 1
		}
	],
	"resourceId": "6ad498d1-c82b-49bb-a524-821cd8a6b68a",
	"resourceType": "ImpositionTemplate"
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/imposition/6ad498d1-c82b-49bb-a524-821cd8a6b68a

Response Payload

{
	"output": {
		"resourceId": "6ad498d1-c82b-49bb-a524-821cd8a6b68a",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558877182592,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 1558272382592,
		"resourceCreationTime": 1558272378787
	},
	"fileName": "simpleBusinessCard.impp"
}

Sample Output Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample

Request Payload

{
	"fileName": "simpleBusinessCard.jpg",
	"templateResourceId": "3592edaa-a2d7-4b14-b2e6-43682576ad9e",
	"dataResourceId": "e314708e-af15-4b90-9422-e1128edb0f4f",
	"impositionTemplateResourceId": "6ad498d1-c82b-49bb-a524-821cd8a6b68a",
	"assetsLibraryResourceIdCollection": null,
	"clientTimestampInMilliseconds": 1558272383775,
	"skipRecords": 1,
	"requiredObjectType": "NonImposedPageRecord",
	"requiredPageRecord": {
		"recordNumber": 2,
		"pageNumber": 1
	},
	"requiredSpreadNumber": null,
	"outputFormat": "JPEG",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1920,
	"pdfFileName": "simpleBusinessCard.pdf",
	"queryMetadata": true
}

Response Payload

{
	"output": {
		"downloadUrl": null,
		"duplex": null,
		"totalNumberOfSheets": null,
		"resourceId": "d2c020c0-558a-455b-980b-942ce8219811",
		"status": "Waiting",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558358784790,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558272384790,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558272384770
	},
	"fileName": "simpleBusinessCard.jpg",
	"templateResourceId": "3592edaa-a2d7-4b14-b2e6-43682576ad9e",
	"dataResourceId": "e314708e-af15-4b90-9422-e1128edb0f4f",
	"impositionTemplateResourceId": "6ad498d1-c82b-49bb-a524-821cd8a6b68a",
	"assetsLibraryResourceIdCollection": {
		"resourceIds": null
	},
	"clientTimestampInMilliseconds": 1558272383775,
	"skipRecords": 1,
	"requiredObjectType": "NonImposedPageRecord",
	"requiredPageRecord": {
		"recordNumber": 2,
		"pageNumber": 1
	},
	"requiredSpreadNumber": null,
	"outputFormat": "JPEG",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1080,
	"pdfFileName": null,
	"queryMetadata": true
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/d2c020c0-558a-455b-980b-942ce8219811

Response Payload

{
	"output": {
		"downloadUrl": "https://d32ddi2h1u3kmm.cloudfront.net/...",
		"duplex": null,
		"totalNumberOfSheets": 0,
		"resourceId": "d2c020c0-558a-455b-980b-942ce8219811",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558358798895,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558272384790,
		"startProcessingTime": 1558272389858,
		"endProcessingTime": 1558272398895,
		"resourceCreationTime": 1558272384770
	},
	"fileName": "simpleBusinessCard.jpg",
	"templateResourceId": "3592edaa-a2d7-4b14-b2e6-43682576ad9e",
	"dataResourceId": "e314708e-af15-4b90-9422-e1128edb0f4f",
	"impositionTemplateResourceId": "6ad498d1-c82b-49bb-a524-821cd8a6b68a",
	"assetsLibraryResourceIdCollection": {
		"resourceIds": null
	},
	"clientTimestampInMilliseconds": 1558272383775,
	"skipRecords": 1,
	"requiredObjectType": "NonImposedPageRecord",
	"requiredPageRecord": {
		"recordNumber": 2,
		"pageNumber": 1
	},
	"requiredSpreadNumber": null,
	"outputFormat": "JPEG",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1080,
	"pdfFileName": null,
	"queryMetadata": true
}

PDF Output Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf

Request Payload

{
	"fileName": "simpleBusinessCard.pdf",
	"templateResourceId": "3592edaa-a2d7-4b14-b2e6-43682576ad9e",
	"dataResourceId": "e314708e-af15-4b90-9422-e1128edb0f4f",
	"impositionTemplateResourceId": "6ad498d1-c82b-49bb-a524-821cd8a6b68a",
	"assetsLibraryResourceIdCollection": null,
	"applyImposition": true,
	"recordsRange": {
		"from": 5,
		"to": 10
	},
	"clientTimestampInMilliseconds": 1558272408305,
	"skipRecords": 1
}

Response Payload

{
	"output": {
		"downloadUrl": null,
		"resourceId": "5928568e-e231-4606-bc57-ec69cdf5f9dd",
		"status": "Waiting",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558877209310,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558272409310,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558272409295
	},
	"fileName": "simpleBusinessCard.pdf",
	"templateResourceId": "3592edaa-a2d7-4b14-b2e6-43682576ad9e",
	"dataResourceId": "e314708e-af15-4b90-9422-e1128edb0f4f",
	"impositionTemplateResourceId": "6ad498d1-c82b-49bb-a524-821cd8a6b68a",
	"assetsLibraryResourceIdCollection": {
		"resourceIds": null
	},
	"applyImposition": true,
	"recordsRange": {
		"from": 5,
		"to": 10
	},
	"skipRecords": 1,
	"clientTimestampInMilliseconds": 1558272408305
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/5928568e-e231-4606-bc57-ec69cdf5f9dd

Response Payload

{
	"output": {
		"downloadUrl": "https://d32ddi2h1u3kmm.cloudfront.net/...",
		"resourceId": "5928568e-e231-4606-bc57-ec69cdf5f9dd",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558877217788,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558272409310,
		"startProcessingTime": 1558272413480,
		"endProcessingTime": 1558272417788,
		"resourceCreationTime": 1558272409295
	},
	"fileName": "simpleBusinessCard.pdf",
	"templateResourceId": "3592edaa-a2d7-4b14-b2e6-43682576ad9e",
	"dataResourceId": "e314708e-af15-4b90-9422-e1128edb0f4f",
	"impositionTemplateResourceId": "6ad498d1-c82b-49bb-a524-821cd8a6b68a",
	"assetsLibraryResourceIdCollection": {
		"resourceIds": null
	},
	"applyImposition": true,
	"recordsRange": {
		"from": 5,
		"to": 10
	},
	"skipRecords": 1,
	"clientTimestampInMilliseconds": 1558272408305
}

Touch Resource

Template input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/lifespan

Request Payload

{
	"resourceIds": [
		"3592edaa-a2d7-4b14-b2e6-43682576ad9e"
	]
}

Response Payload

{
	"resourceIds": [
		"3592edaa-a2d7-4b14-b2e6-43682576ad9e"
	],
	"newExpirationTime": 1558877222684
}

Touch Data input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/lifespan

Request Payload

{
	"resourceIds": [
		"e314708e-af15-4b90-9422-e1128edb0f4f"
	]
}

Response Payload

{
	"resourceIds": [
		"6ad498d1-c82b-49bb-a524-821cd8a6b68a"
	],
	"newExpirationTime": 1558877225037
}

Touch Imposition Template input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/imposition/lifespan

Request Payload

{
	"resourceIds": [
		"6ad498d1-c82b-49bb-a524-821cd8a6b68a"
	]
}

Response Payload

{
	"resourceIds": [
		"6ad498d1-c82b-49bb-a524-821cd8a6b68a"
	],
	"newExpirationTime": 1558877225037
}

Touch Sample output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/lifespan

Request Payload

{
	"resourceIds": [
		"d2c020c0-558a-455b-980b-942ce8219811"
	]
}

Response Payload

{
	"resourceIds": [
		"d2c020c0-558a-455b-980b-942ce8219811"
	],
	"newExpirationTime": 1558358826217
}

Touch PDF output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/lifespan

Request Payload

{
	"resourceIds": [
		"5928568e-e231-4606-bc57-ec69cdf5f9dd"
	]
}

Response Payload

{
	"resourceIds": [
		"5928568e-e231-4606-bc57-ec69cdf5f9dd"
	],
	"newExpirationTime": 1558877227370
}

Delete Resource

Delete Template input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/delete

Request Payload

{
	"resourceIds": [
		"3592edaa-a2d7-4b14-b2e6-43682576ad9e"
	]
}

Delete Data input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/delete

Request Payload

{
	"resourceIds": [
		"e314708e-af15-4b90-9422-e1128edb0f4f"
	]
}

Delete Imposition Template input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/imposition/delete

Request Payload

{
	"resourceIds": [
		"6ad498d1-c82b-49bb-a524-821cd8a6b68a"
	]
}

Delete Sample output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/delete

Request Payload

{
	"resourceIds": [
		"d2c020c0-558a-455b-980b-942ce8219811"
	]
}

Delete PDF output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/delete

Request Payload

{
	"resourceIds": [
		"5928568e-e231-4606-bc57-ec69cdf5f9dd"
	]
}

“Mosaic Notebook” Example

This example is taken from the SDK Client Sample code execution.

In this example:

  1. VDP Template input Resource using mosaicNotebook.hpd file
  2. Data input Resource using mosaicNotebook.txt
    1. Tab delimiter (ascii 9)
  3. No Imposition Template Resource – the imposition is taken from embedded imposition file packed inside the HPD file.
  4. No use of assets Library
  5. Request for Sample output resource
    1. The output format is requested as PDF
    2. Request to skip first row of the data file
    3. Request for imposed spread number 2
    4. Use PDF name mosaicNotebook.pdf in case there is marks set with PDF name in it
    5. Ask to have output file with the name mosaicNotebook.pdf
  6. Request for PDF output resource
    1. Request to skip first row of the data file
    2. Request to apply imposition
    3. Ask to have output file with the name mosaicNotebook.pdf

VDP Input Template Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template

Request Payload:

{
	"fileName": "mosaicNotebook.hpd"
}

Response Payload:

{
	"fileName": "mosaicNotebook.hpd",
	"output": {
		"richTemplate": false,
		"embeddedImpositionExist": false,
		"numberOfPages": 0,
		"resourceId": "da2819fc-4718-4063-b8bb-f2a123a86141",
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558363741980,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558277341980
	}
}

Upload File

Request upload PUT URLs

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/put-urls

Request Payload:

{
	"resourceId": "da2819fc-4718-4063-b8bb-f2a123a86141",
	"resourceType": "Template",
	"fileSize": 5581022,
	"partSize": 5242880
}

Response Payload:

{
	"presignedUploadUrls": [
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		},
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		}
	]
}

Parts Upload Completion

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/parts

Request Payload:

{
	"uploadPartInfos": [
		{
			"eTag": "e7528af3971089ec68165eabdb8d8da8",
			"partNumber": 1
		},
		{
			"eTag": "928abd73f22cb34cabb81744fcdab8d6",
			"partNumber": 2
		}
	],
	"resourceId": "da2819fc-4718-4063-b8bb-f2a123a86141",
	"resourceType": "Template"
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/da2819fc-4718-4063-b8bb-f2a123a86141

Response Payload:

{
	"fileName": "mosaicNotebook.hpd",
	"output": {
		"richTemplate": false,
		"embeddedImpositionExist": true,
		"numberOfPages": 1,
		"resourceId": "da2819fc-4718-4063-b8bb-f2a123a86141",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558882164663,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558277347660,
		"startProcessingTime": 1558277354765,
		"endProcessingTime": 1558277364663,
		"resourceCreationTime": 1558277341980
	}
}

Data Input Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data

Request Payload:

{
	"dataFormatDelimiter": 9,
	"fileName": "mosaicNotebook.txt"
}

Response Payload:

{
	"output": {
		"resourceId": "b785b652-c85a-4c66-90b0-a3c13e7b15de",
		"numberOfRecords": 0,
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558363772009,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558277372009
	},
	"dataFormatDelimiter": 9,
	"fileName": "mosaicNotebook.txt"
}

Upload File

Request upload PUT URLs

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/put-urls

Request Payload:

{
	"resourceId": "b785b652-c85a-4c66-90b0-a3c13e7b15de",
	"resourceType": "Data",
	"fileSize": 626,
	"partSize": 5242880
}

Response Payload:

{
	"presignedUploadUrls": [
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		}
	]
}

Parts Upload Completion

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/parts

Request Payload:

{
	"uploadPartInfos": [
		{
			"eTag": "f85aaa1c8e607412fbd92f4bb1b96c32",
			"partNumber": 1
		}
	],
	"resourceId": "b785b652-c85a-4c66-90b0-a3c13e7b15de",
	"resourceType": "Data"
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/b785b652-c85a-4c66-90b0-a3c13e7b15de

Response Payload:

{
	"output": {
		"resourceId": "b785b652-c85a-4c66-90b0-a3c13e7b15de",
		"numberOfRecords": 25,
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558882177835,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558277375951,
		"startProcessingTime": 1558277377563,
		"endProcessingTime": 1558277377835,
		"resourceCreationTime": 1558277372009
	},
	"dataFormatDelimiter": 9,
	"fileName": "mosaicNotebook.txt"
}

Sample Output Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample

Request Payload:

{
	"fileName": "mosaicNotebook.pdf",
	"templateResourceId": "da2819fc-4718-4063-b8bb-f2a123a86141",
	"dataResourceId": "b785b652-c85a-4c66-90b0-a3c13e7b15de",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": null,
	"clientTimestampInMilliseconds": 1558277388273,
	"skipRecords": 1,
	"requiredObjectType": "ImposedSpread",
	"requiredPageRecord": null,
	"requiredSpreadNumber": 2,
	"outputFormat": "PDF",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1920,
	"pdfFileName": "mosaicNotebook.pdf",
	"queryMetadata": true
}

Response Payload:

{
	"output": {
		"downloadUrl": null,
		"duplex": null,
		"totalNumberOfSheets": null,
		"resourceId": "4e9602ad-4a6c-40fd-bb55-bb777c96f005",
		"status": "Waiting",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558363789271,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558277389271,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558277389252
	},
	"fileName": "mosaicNotebook.pdf",
	"templateResourceId": "da2819fc-4718-4063-b8bb-f2a123a86141",
	"dataResourceId": "b785b652-c85a-4c66-90b0-a3c13e7b15de",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": null
	},
	"clientTimestampInMilliseconds": 1558277388273,
	"skipRecords": 1,
	"requiredObjectType": "ImposedSpread",
	"requiredPageRecord": null,
	"requiredSpreadNumber": 2,
	"outputFormat": "PDF",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1080,
	"pdfFileName": null,
	"queryMetadata": true
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/4e9602ad-4a6c-40fd-bb55-bb777c96f005

Response Payload:

{
	"output": {
		"downloadUrl": "https://d32ddi2h1u3kmm.cloudfront.net/...",
		"duplex": false,
		"totalNumberOfSheets": 4,
		"resourceId": "4e9602ad-4a6c-40fd-bb55-bb777c96f005",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558363804851,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558277389271,
		"startProcessingTime": 1558277392642,
		"endProcessingTime": 1558277404851,
		"resourceCreationTime": 1558277389252
	},
	"fileName": "mosaicNotebook.pdf",
	"templateResourceId": "da2819fc-4718-4063-b8bb-f2a123a86141",
	"dataResourceId": "b785b652-c85a-4c66-90b0-a3c13e7b15de",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": null
	},
	"clientTimestampInMilliseconds": 1558277388273,
	"skipRecords": 1,
	"requiredObjectType": "ImposedSpread",
	"requiredPageRecord": null,
	"requiredSpreadNumber": 2,
	"outputFormat": "PDF",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1080,
	"pdfFileName": null,
	"queryMetadata": true
}

PDF Output Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf

Request Payload:

{
	"fileName": "mosaicNoteBook.pdf",
	"templateResourceId": "da2819fc-4718-4063-b8bb-f2a123a86141",
	"dataResourceId": "b785b652-c85a-4c66-90b0-a3c13e7b15de",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": null,
	"applyImposition": true,
	"recordsRange": null,
	"clientTimestampInMilliseconds": 1558277412821,
	"skipRecords": 1
}

Response Payload:

{
	"output": {
		"downloadUrl": null,
		"resourceId": "5996d5c0-9368-49d4-aad6-def418189f0f",
		"status": "Waiting",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558882213840,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558277413840,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558277413820
	},
	"fileName": "mosaicNoteBook.pdf",
	"templateResourceId": "da2819fc-4718-4063-b8bb-f2a123a86141",
	"dataResourceId": "b785b652-c85a-4c66-90b0-a3c13e7b15de",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": null
	},
	"applyImposition": true,
	"recordsRange": {
		"from": null,
		"to": null
	},
	"skipRecords": 1,
	"clientTimestampInMilliseconds": 1558277412821
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/5996d5c0-9368-49d4-aad6-def418189f0f

Response Payload:

{
	"output": {
		"downloadUrl": "https://d32ddi2h1u3kmm.cloudfront.net/...",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558882224101,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558277413840,
		"startProcessingTime": 1558277415615,
		"endProcessingTime": 1558277424101,
		"resourceCreationTime": 1558277413820
	},
	"fileName": "mosaicNoteBook.pdf",
	"templateResourceId": "da2819fc-4718-4063-b8bb-f2a123a86141",
	"dataResourceId": "b785b652-c85a-4c66-90b0-a3c13e7b15de",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": null
	},
	"applyImposition": true,
	"recordsRange": {
		"from": null,
		"to": null
	},
	"skipRecords": 1,
	"clientTimestampInMilliseconds": 1558277412821
}

Touch Resource

Touch Template input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/lifespan

Request Payload:

{
	"resourceIds": [
		"da2819fc-4718-4063-b8bb-f2a123a86141"
	]
}

Response Payload:

{
	"resourceIds": [
		"da2819fc-4718-4063-b8bb-f2a123a86141"
	],
	"newExpirationTime": 1558882227147
}

Touch Data input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/lifespan

Request Payload:

{
	"resourceIds": [
		"b785b652-c85a-4c66-90b0-a3c13e7b15de"
	]
}

Response Payload:

{
	"resourceIds": [
		"b785b652-c85a-4c66-90b0-a3c13e7b15de"
	],
	"newExpirationTime": 1558882228331
}

Touch Sample output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/lifespan

Request Payload:

{
	"resourceIds": [
		"4e9602ad-4a6c-40fd-bb55-bb777c96f005"
	]
}

Response Payload:

{
	"resourceIds": [
		"4e9602ad-4a6c-40fd-bb55-bb777c96f005"
	],
	"newExpirationTime": 1558363829490
}

Touch PDF output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/lifespan

Request Payload:

{
	"resourceIds": [
		"5996d5c0-9368-49d4-aad6-def418189f0f"
	]
}

Response Payload:

{
	"resourceIds": [
		"5996d5c0-9368-49d4-aad6-def418189f0f"
	],
	"newExpirationTime": 1558882230624
}

Delete Resource

Delete Template input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/delete

Request Payload:

{
	"resourceIds": [
		"da2819fc-4718-4063-b8bb-f2a123a86141"
	]
}

Delete Data input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/delete

Request Payload:

{
	"resourceIds": [
		"b785b652-c85a-4c66-90b0-a3c13e7b15de"
	]
}

Delete Sample output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/delete

Request Payload:

{
	"resourceIds": [
		"4e9602ad-4a6c-40fd-bb55-bb777c96f005"
	]
}

Delete PDF output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/delete

Request Payload:

{
	"resourceIds": [
		"5996d5c0-9368-49d4-aad6-def418189f0f"
	]
}

“Example with Assets Library” Example

This example is taken from the SDK Client Sample code execution.

In this example:

  1. VDP Template input Resource using ImageAssetsExample.hpd file
  2. Data input Resource using ImageAssetsExample.txt
    1. Tab delimiter (ascii 9)
  3. Imposition Template not in use
  4. Assets Library input Resource using ImageAssetsExample.zip
  5. Request for Sample output resource
    1. The output format is requested as JPEG
    2. Request to skip first row of the data file
    3. Request for non-imposed result – record 3 of page 1
    4. Use PDF name ImageAssetsExample.pdf in case there is marks set with PDF name in it
    5. Ask to have output file with the name simpleBusinessCard.jpg
  6. Request for PDF output resource
    1. Request to skip first row of the data file
    2. Request NOT to apply imposition
    3. Ask to have output file with the name ImageAssetsExample.pdf

VDP Input Template Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template

Request Payload:

{
	"fileName": "ImageAssetsExample.hpd"
}

Response Payload:

{
	"fileName": "ImageAssetsExample.hpd",
	"output": {
		"richTemplate": false,
		"embeddedImpositionExist": false,
		"numberOfPages": 0,
		"resourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558365499299,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558279099299
	}
}

Upload File

Request upload PUT URLs

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/put-urls

Request Payload:

{
	"resourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"resourceType": "Template",
	"fileSize": 11352131,
	"partSize": 5242880
}

Response Payload:

{
	"presignedUploadUrls": [
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		},
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		},
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		}
	]
}

Parts Upload Completion

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/parts

Request Payload:

{
	"uploadPartInfos": [
		{
			"eTag": "65b8afd51fb2eaf4754e3d36b1d5ed82",
			"partNumber": 1
		},
		{
			"eTag": "3689ff515801e15d502fa76fb87fa773",
			"partNumber": 2
		},
		{
			"eTag": "185a29f579e37938c50be3b28fd28447",
			"partNumber": 3
		}
	],
	"resourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"resourceType": "Template"
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/cd2382b3-d8d2-4136-8b23-5e062dbbf989

Response Payload:

{
	"fileName": "ImageAssetsExample.hpd",
	"output": {
		"richTemplate": false,
		"embeddedImpositionExist": false,
		"numberOfPages": 1,
		"resourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558883917135,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279104770,
		"startProcessingTime": 1558279109783,
		"endProcessingTime": 1558279117135,
		"resourceCreationTime": 1558279099299
	}
}

Data Input Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data

Request Payload:

{
	"dataFormatDelimiter": 9,
	"fileName": "ImageAssetsExample.txt"
}

Response Payload:

{
	"output": {
		"resourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
		"numberOfRecords": 0,
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558365529171,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558279129171
	},
	"dataFormatDelimiter": 9,
	"fileName": "ImageAssetsExample.txt"
}

Upload File

Request upload PUT URLs

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/put-urls

Request Payload:

{
	"resourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"resourceType": "Data",
	"fileSize": 310,
	"partSize": 5242880
}

Response Payload:

{
	"presignedUploadUrls": [
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		}
	]
}

Parts Upload Completion

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/parts

Request Payload:

{
	"uploadPartInfos": [
		{
			"eTag": "8a99a1ba7288fea5dec7956ba8f3fb16",
			"partNumber": 1
		}
	],
	"resourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"resourceType": "Data"
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/ecf4d54f-6239-48e8-bf16-9279954c2266

Response Payload:

{
	"output": {
		"resourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
		"numberOfRecords": 17,
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558883940247,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279133297,
		"startProcessingTime": 1558279139885,
		"endProcessingTime": 1558279140247,
		"resourceCreationTime": 1558279129171
	},
	"dataFormatDelimiter": 9,
	"fileName": "ImageAssetsExample.txt"
}

Assets Library Input Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assetslibrary

Request Payload:

{
	"fileName": "ImageAssetsExample.zip"
}

Response Payload:

{
	"output": {
		"resourceId": "06caea8a-d055-4bbc-b1c1-4267509c7f81",
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558365546795,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558279146795
	},
	"fileName": "ImageAssetsExample.zip"
}

Upload File

Request upload PUT URLs

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/put-urls

Request Payload:

{
	"resourceId": "06caea8a-d055-4bbc-b1c1-4267509c7f81",
	"resourceType": "AssetsLibrary",
	"fileSize": 11107082,
	"partSize": 5242880
}

Response Payload:

{
	"presignedUploadUrls": [
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		},
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		},
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		}
	]
}

Parts Upload Completion

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/parts

Request Payload:

{
	"uploadPartInfos": [
		{
			"eTag": "3fcb22d980a795481b865e548fe5c87a",
			"partNumber": 1
		},
		{
			"eTag": "b3d1838acf52f49151e9786aa2d54c0f",
			"partNumber": 2
		},
		{
			"eTag": "033115e616c5e8cc2f57b1b69418e000",
			"partNumber": 3
		}
	],
	"resourceId": "06caea8a-d055-4bbc-b1c1-4267509c7f81",
	"resourceType": "AssetsLibrary"
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/assetslibrary/06caea8a-d055-4bbc-b1c1-4267509c7f81

Response Payload:

{
	"output": {
		"resourceId": "06caea8a-d055-4bbc-b1c1-4267509c7f81",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558883952347,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 1558279152347,
		"resourceCreationTime": 1558279146795
	},
	"fileName": "ImageAssetsExample.zip"
}

Sample Output Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample

Request Payload:

{
	"fileName": "ImageAssetsExample.jpg",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"clientTimestampInMilliseconds": 1558279153530,
	"skipRecords": 1,
	"requiredObjectType": "NonImposedPageRecord",
	"requiredPageRecord": {
		"recordNumber": 3,
		"pageNumber": 1
	},
	"requiredSpreadNumber": null,
	"outputFormat": "JPEG",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1920,
	"pdfFileName": "ImageAssetsExample.pdf",
	"queryMetadata": true
}

Response Payload:

{
	"output": {
		"downloadUrl": null,
		"duplex": null,
		"totalNumberOfSheets": null,
		"resourceId": "93df17a6-de3b-41c2-9338-2f9118315900",
		"status": "Waiting",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558365554571,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279154571,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558279154554
	},
	"fileName": "ImageAssetsExample.jpg",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"clientTimestampInMilliseconds": 1558279153530,
	"skipRecords": 1,
	"requiredObjectType": "NonImposedPageRecord",
	"requiredPageRecord": {
		"recordNumber": 3,
		"pageNumber": 1
	},
	"requiredSpreadNumber": null,
	"outputFormat": "JPEG",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1080,
	"pdfFileName": null,
	"queryMetadata": true
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/93df17a6-de3b-41c2-9338-2f9118315900

Response Payload:

{
	"output": {
		"downloadUrl": "https://d32ddi2h1u3kmm.cloudfront.net/...",
		"duplex": null,
		"totalNumberOfSheets": 0,
		"resourceId": "93df17a6-de3b-41c2-9338-2f9118315900",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558365566470,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279154571,
		"startProcessingTime": 1558279154756,
		"endProcessingTime": 1558279166470,
		"resourceCreationTime": 1558279154554
	},
	"fileName": "ImageAssetsExample.jpg",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"clientTimestampInMilliseconds": 1558279153530,
	"skipRecords": 1,
	"requiredObjectType": "NonImposedPageRecord",
	"requiredPageRecord": {
		"recordNumber": 3,
		"pageNumber": 1
	},
	"requiredSpreadNumber": null,
	"outputFormat": "JPEG",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1080,
	"pdfFileName": null,
	"queryMetadata": true
}

PDF Output Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf

Request Payload:

{
	"fileName": "ImageAssetsExample.pdf",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"applyImposition": false,
	"recordsRange": null,
	"clientTimestampInMilliseconds": 1558279166988,
	"skipRecords": 1
}

Response Payload:

{
	"output": {
		"downloadUrl": null,
		"resourceId": "fec96ef8-fbfe-4584-83fb-5f44d123428a",
		"status": "Waiting",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558883968012,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279168012,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558279167990
	},
	"fileName": "ImageAssetsExample.pdf",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"applyImposition": false,
	"recordsRange": {
		"from": null,
		"to": null
	},
	"skipRecords": 1,
	"clientTimestampInMilliseconds": 1558279166988
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/fec96ef8-fbfe-4584-83fb-5f44d123428a

Response Payload:

{
	"output": {
		"downloadUrl": "https://d32ddi2h1u3kmm.cloudfront.net/...",
		"resourceId": "fec96ef8-fbfe-4584-83fb-5f44d123428a",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558883993675,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279168012,
		"startProcessingTime": 1558279170953,
		"endProcessingTime": 1558279193675,
		"resourceCreationTime": 1558279167990
	},
	"fileName": "ImageAssetsExample.pdf",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"applyImposition": false,
	"recordsRange": {
		"from": null,
		"to": null
	},
	"skipRecords": 1,
	"clientTimestampInMilliseconds": 1558279166988
}

Touch Resource

Touch Template input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/lifespan

Request Payload:

{
	"resourceIds": [
		"cd2382b3-d8d2-4136-8b23-5e062dbbf989"
	]
}

Response Payload:

{
	"resourceIds": [
		"cd2382b3-d8d2-4136-8b23-5e062dbbf989"
	],
	"newExpirationTime": 1558884003612
}

Touch Data input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/lifespan

Request Payload:

{
	"resourceIds": [
		"ecf4d54f-6239-48e8-bf16-9279954c2266"
	]
}

Response Payload:

{
	"resourceIds": [
		"ecf4d54f-6239-48e8-bf16-9279954c2266"
	],
	"newExpirationTime": 1558884004768
}

Touch Assets Library input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assetslibrary/lifespan

Request Payload:

{
	"resourceIds": [
		"06caea8a-d055-4bbc-b1c1-4267509c7f81"
	]
}

Response Payload:

{
	"resourceIds": [
		"06caea8a-d055-4bbc-b1c1-4267509c7f81"
	],
	"newExpirationTime": 1558884005927
}

Touch Sample output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/lifespan

Request Payload:

{
	"resourceIds": [
		"93df17a6-de3b-41c2-9338-2f9118315900"
	]
}

Response Payload:

{
	"resourceIds": [
		"93df17a6-de3b-41c2-9338-2f9118315900"
	],
	"newExpirationTime": 1558365607085
}

Touch PDF output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/lifespan

Request Payload:

{
	"resourceIds": [
		"fec96ef8-fbfe-4584-83fb-5f44d123428a"
	]
}

Response Payload:

{
	"resourceIds": [
		"fec96ef8-fbfe-4584-83fb-5f44d123428a"
	],
	"newExpirationTime": 1558884008230
}

Delete Resource

Delete Template input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/delete

Request Payload:

{
	"resourceIds": [
		"cd2382b3-d8d2-4136-8b23-5e062dbbf989"
	]
}

Delete Data input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/delete

Request Payload:

{
	"resourceIds": [
		"ecf4d54f-6239-48e8-bf16-9279954c2266"
	]
}

Delete Assets Library input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assetslibrary/delete

Request Payload:

{
	"resourceIds": [
		"06caea8a-d055-4bbc-b1c1-4267509c7f81"
	]
}

Delete Sample output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/delete

Request Payload:

{
	"resourceIds": [
		"93df17a6-de3b-41c2-9338-2f9118315900"
	]
}

Delete PDF output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/delete

Request Payload:

{
	"resourceIds": [
		"fec96ef8-fbfe-4584-83fb-5f44d123428a"
	]
}

“Example with Assets Library by Url” Example

This example is taken from the SDK Client Sample code execution.

In this example:

  1. VDP Template input Resource using ImageAssetsExample.hpd file
  2. Data input Resource using ImageAssetsExample.txt
    1. Tab delimiter (ascii 9)
  3. Imposition Template not in use
  4. Assets library will be provided as an array of urls
  5. Request for Sample output resource
    1. The output format is requested as JPEG
    2. Request to skip first row of the data file
    3. Request for non-imposed result – record 3 of page 1
    4. Use PDF name ImageAssetsExample.pdf in case there is marks set with PDF name in it
    5. Ask to have output file with the name simpleBusinessCard.jpg
  6. Request for PDF output resource
    1. Request to skip first row of the data file
    2. Request NOT to apply imposition
    3. Ask to have output file with the name ImageAssetsExample.pdf

VDP Input Template Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template

Request Payload:

{
	"fileName": "ImageAssetsExample.hpd"
}

Response Payload:

{
	"fileName": "ImageAssetsExample.hpd",
	"output": {
		"richTemplate": false,
		"embeddedImpositionExist": false,
		"numberOfPages": 0,
		"resourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558365499299,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558279099299
	}
}

Upload File

Request upload PUT URLs

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/put-urls

Request Payload:

{
	"resourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"resourceType": "Template",
	"fileSize": 11352131,
	"partSize": 5242880
}

Response Payload:

{
	"presignedUploadUrls": [
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		},
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		},
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		}
	]
}

Parts Upload Completion

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/parts

Request Payload:

{
	"uploadPartInfos": [
		{
			"eTag": "65b8afd51fb2eaf4754e3d36b1d5ed82",
			"partNumber": 1
		},
		{
			"eTag": "3689ff515801e15d502fa76fb87fa773",
			"partNumber": 2
		},
		{
			"eTag": "185a29f579e37938c50be3b28fd28447",
			"partNumber": 3
		}
	],
	"resourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"resourceType": "Template"
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/cd2382b3-d8d2-4136-8b23-5e062dbbf989

Response Payload:

{
	"fileName": "ImageAssetsExample.hpd",
	"output": {
		"richTemplate": false,
		"embeddedImpositionExist": false,
		"numberOfPages": 1,
		"resourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558883917135,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279104770,
		"startProcessingTime": 1558279109783,
		"endProcessingTime": 1558279117135,
		"resourceCreationTime": 1558279099299
	}
}

Data Input Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data

Request Payload:

{
	"dataFormatDelimiter": 9,
	"fileName": "ImageAssetsExample.txt"
}

Response Payload:

{
	"output": {
		"resourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
		"numberOfRecords": 0,
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558365529171,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558279129171
	},
	"dataFormatDelimiter": 9,
	"fileName": "ImageAssetsExample.txt"
}

Upload File

Request upload PUT URLs

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/put-urls

Request Payload:

{
	"resourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"resourceType": "Data",
	"fileSize": 310,
	"partSize": 5242880
}

Response Payload:

{
	"presignedUploadUrls": [
		{
			"presignedUrl": "https://printos-generic-storage-cd.s3.dualstack.us-east-1.amazonaws.com/..."
		}
	]
}

Parts Upload Completion

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assets/parts

Request Payload:

{
	"uploadPartInfos": [
		{
			"eTag": "8a99a1ba7288fea5dec7956ba8f3fb16",
			"partNumber": 1
		}
	],
	"resourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"resourceType": "Data"
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/ecf4d54f-6239-48e8-bf16-9279954c2266

Response Payload:

{
	"output": {
		"resourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
		"numberOfRecords": 17,
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558883940247,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279133297,
		"startProcessingTime": 1558279139885,
		"endProcessingTime": 1558279140247,
		"resourceCreationTime": 1558279129171
	},
	"dataFormatDelimiter": 9,
	"fileName": "ImageAssetsExample.txt"
}

Assets Library Input Resource

the "byUrl" property accepts either a single URL value for the assets zip file for example:

byUrl": "https://composer-dev-cd.s3.amazonaws.com/sdkTest/ImageAssetsExample.zip"

Or an array of asset URLs, each representing an asset file: 

"byUrl": [
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180110.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180112.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180114.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180116.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180120.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180122.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180127.jpg"
	]

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assetslibrary

Request Payload:

{
	"fileName": "ImageAssetsExample.zip",
	"byUrl": [
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180110.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180112.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180114.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180116.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180120.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180122.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180127.jpg"
	]
}

Response Payload:

{
	"output": {
		"resourceId": "06caea8a-d055-4bbc-b1c1-4267509c7f81",
		"status": "Created",
		"uploadCompleted": false,
		"errorType": null,
		"expirationTime": 1558365546795,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 0,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558279146795
	},
	"fileName": "ImageAssetsExample.zip",
	"byUrl": [
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180110.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180112.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180114.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180116.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180120.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180122.jpg",
		"https://cdn.printos.cn/images/composer/sdkTests/byurl/20190513_180127.jpg"
	]
}

Sample Output Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample

Request Payload:

{
	"fileName": "ImageAssetsExample.jpg",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"clientTimestampInMilliseconds": 1558279153530,
	"skipRecords": 1,
	"requiredObjectType": "NonImposedPageRecord",
	"requiredPageRecord": {
		"recordNumber": 3,
		"pageNumber": 1
	},
	"requiredSpreadNumber": null,
	"outputFormat": "JPEG",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1920,
	"pdfFileName": "ImageAssetsExample.pdf",
	"queryMetadata": true
}

Response Payload:

{
	"output": {
		"downloadUrl": null,
		"duplex": null,
		"totalNumberOfSheets": null,
		"resourceId": "93df17a6-de3b-41c2-9338-2f9118315900",
		"status": "Waiting",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558365554571,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279154571,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558279154554
	},
	"fileName": "ImageAssetsExample.jpg",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"clientTimestampInMilliseconds": 1558279153530,
	"skipRecords": 1,
	"requiredObjectType": "NonImposedPageRecord",
	"requiredPageRecord": {
		"recordNumber": 3,
		"pageNumber": 1
	},
	"requiredSpreadNumber": null,
	"outputFormat": "JPEG",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1080,
	"pdfFileName": null,
	"queryMetadata": true
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/93df17a6-de3b-41c2-9338-2f9118315900

Response Payload:

{
	"output": {
		"downloadUrl": "https://d32ddi2h1u3kmm.cloudfront.net/...",
		"duplex": null,
		"totalNumberOfSheets": 0,
		"resourceId": "93df17a6-de3b-41c2-9338-2f9118315900",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558365566470,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279154571,
		"startProcessingTime": 1558279154756,
		"endProcessingTime": 1558279166470,
		"resourceCreationTime": 1558279154554
	},
	"fileName": "ImageAssetsExample.jpg",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"clientTimestampInMilliseconds": 1558279153530,
	"skipRecords": 1,
	"requiredObjectType": "NonImposedPageRecord",
	"requiredPageRecord": {
		"recordNumber": 3,
		"pageNumber": 1
	},
	"requiredSpreadNumber": null,
	"outputFormat": "JPEG",
	"deviceScreenHeight": 1080,
	"deviceScreenWidth": 1080,
	"pdfFileName": null,
	"queryMetadata": true
}

PDF Output Resource

Resource Creation

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf

Request Payload:

{
	"fileName": "ImageAssetsExample.pdf",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"applyImposition": false,
	"recordsRange": null,
	"clientTimestampInMilliseconds": 1558279166988,
	"skipRecords": 1
}

Response Payload:

{
	"output": {
		"downloadUrl": null,
		"resourceId": "fec96ef8-fbfe-4584-83fb-5f44d123428a",
		"status": "Waiting",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558883968012,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279168012,
		"startProcessingTime": 0,
		"endProcessingTime": 0,
		"resourceCreationTime": 1558279167990
	},
	"fileName": "ImageAssetsExample.pdf",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"applyImposition": false,
	"recordsRange": {
		"from": null,
		"to": null
	},
	"skipRecords": 1,
	"clientTimestampInMilliseconds": 1558279166988
}

Get Resource

GET on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/fec96ef8-fbfe-4584-83fb-5f44d123428a

Response Payload:

{
	"output": {
		"downloadUrl": "https://d32ddi2h1u3kmm.cloudfront.net/...",
		"resourceId": "fec96ef8-fbfe-4584-83fb-5f44d123428a",
		"status": "Ready",
		"uploadCompleted": true,
		"errorType": null,
		"expirationTime": 1558883993675,
		"warningMessages": [],
		"errorMessages": [],
		"startWaitingTime": 1558279168012,
		"startProcessingTime": 1558279170953,
		"endProcessingTime": 1558279193675,
		"resourceCreationTime": 1558279167990
	},
	"fileName": "ImageAssetsExample.pdf",
	"templateResourceId": "cd2382b3-d8d2-4136-8b23-5e062dbbf989",
	"dataResourceId": "ecf4d54f-6239-48e8-bf16-9279954c2266",
	"impositionTemplateResourceId": null,
	"assetsLibraryResourceIdCollection": {
		"resourceIds": [
			"06caea8a-d055-4bbc-b1c1-4267509c7f81"
		]
	},
	"applyImposition": false,
	"recordsRange": {
		"from": null,
		"to": null
	},
	"skipRecords": 1,
	"clientTimestampInMilliseconds": 1558279166988
}

Touch Resource

Touch Template input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/lifespan

Request Payload:

{
	"resourceIds": [
		"cd2382b3-d8d2-4136-8b23-5e062dbbf989"
	]
}

Response Payload:

{
	"resourceIds": [
		"cd2382b3-d8d2-4136-8b23-5e062dbbf989"
	],
	"newExpirationTime": 1558884003612
}

Touch Data input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/lifespan

Request Payload:

{
	"resourceIds": [
		"ecf4d54f-6239-48e8-bf16-9279954c2266"
	]
}

Response Payload:

{
	"resourceIds": [
		"ecf4d54f-6239-48e8-bf16-9279954c2266"
	],
	"newExpirationTime": 1558884004768
}

Touch Assets Library input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assetslibrary/lifespan

Request Payload:

{
	"resourceIds": [
		"06caea8a-d055-4bbc-b1c1-4267509c7f81"
	]
}

Response Payload:

{
	"resourceIds": [
		"06caea8a-d055-4bbc-b1c1-4267509c7f81"
	],
	"newExpirationTime": 1558884005927
}

Touch Sample output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/lifespan

Request Payload:

{
	"resourceIds": [
		"93df17a6-de3b-41c2-9338-2f9118315900"
	]
}

Response Payload:

{
	"resourceIds": [
		"93df17a6-de3b-41c2-9338-2f9118315900"
	],
	"newExpirationTime": 1558365607085
}

Touch PDF output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/lifespan

Request Payload:

{
	"resourceIds": [
		"fec96ef8-fbfe-4584-83fb-5f44d123428a"
	]
}

Response Payload:

{
	"resourceIds": [
		"fec96ef8-fbfe-4584-83fb-5f44d123428a"
	],
	"newExpirationTime": 1558884008230
}

Delete Resource

Delete Template input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/template/delete

Request Payload:

{
	"resourceIds": [
		"cd2382b3-d8d2-4136-8b23-5e062dbbf989"
	]
}

Delete Data input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/data/delete

Request Payload:

{
	"resourceIds": [
		"ecf4d54f-6239-48e8-bf16-9279954c2266"
	]
}

Delete Assets Library input resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/assetslibrary/delete

Request Payload:

{
	"resourceIds": [
		"06caea8a-d055-4bbc-b1c1-4267509c7f81"
	]
}

Delete Sample output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/sample/delete

Request Payload:

{
	"resourceIds": [
		"93df17a6-de3b-41c2-9338-2f9118315900"
	]
}

Delete PDF output resource

POST on https://printos.api.hp.com/composer-service/composer/sdk/v1/pdf/delete

Request Payload:

{
	"resourceIds": [
		"fec96ef8-fbfe-4584-83fb-5f44d123428a"
	]
}