🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
curl --request POST \
--url https://api2.rhombussystems.com/api/upload/badgeTemplate/images \
--header 'Content-Type: multipart/form-data' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--form 'bodyParts={
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"parent": {
"bodyParts": "<array>",
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"providers": {}
},
"providers": {}
}' \
--form 'contentDisposition={
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
}' \
--form 'entity={}' \
--form 'fields={}' \
--form 'headers={
"empty": true
}' \
--form 'mediaType={
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
}' \
--form 'messageBodyWorkers={}' \
--form 'parameterizedHeaders={
"empty": true
}' \
--form 'parent={
"bodyParts": "<array>",
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"providers": {}
}' \
--form 'providers={}'{
"allowedMethods": [
"<string>"
],
"closed": true,
"cookies": {},
"date": "2023-11-07T05:31:56Z",
"entity": {},
"entityTag": {
"value": "<string>",
"weak": true
},
"headers": {
"empty": true
},
"language": {
"country": "<string>",
"displayCountry": "<string>",
"displayLanguage": "<string>",
"displayName": "<string>",
"displayScript": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Country": "<string>",
"iso3Language": "<string>",
"language": "<string>",
"script": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"variant": "<string>"
},
"lastModified": "2023-11-07T05:31:56Z",
"length": 123,
"links": [
{
"params": {},
"rel": "<string>",
"rels": [
"<string>"
],
"title": "<string>",
"type": "<string>",
"uri": "<string>",
"uriBuilder": {}
}
],
"location": "<string>",
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"metadata": {
"empty": true
},
"status": 123,
"statusInfo": {
"family": "INFORMATIONAL",
"reasonPhrase": "<string>",
"statusCode": 123
},
"stringHeaders": {
"empty": true
}
}Uploads images for badge templates with associated metadata, supporting JPEG and PNG formats with size validation and automatic S3 storage.
curl --request POST \
--url https://api2.rhombussystems.com/api/upload/badgeTemplate/images \
--header 'Content-Type: multipart/form-data' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--form 'bodyParts={
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"parent": {
"bodyParts": "<array>",
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"providers": {}
},
"providers": {}
}' \
--form 'contentDisposition={
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
}' \
--form 'entity={}' \
--form 'fields={}' \
--form 'headers={
"empty": true
}' \
--form 'mediaType={
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
}' \
--form 'messageBodyWorkers={}' \
--form 'parameterizedHeaders={
"empty": true
}' \
--form 'parent={
"bodyParts": "<array>",
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"providers": {}
}' \
--form 'providers={}'{
"allowedMethods": [
"<string>"
],
"closed": true,
"cookies": {},
"date": "2023-11-07T05:31:56Z",
"entity": {},
"entityTag": {
"value": "<string>",
"weak": true
},
"headers": {
"empty": true
},
"language": {
"country": "<string>",
"displayCountry": "<string>",
"displayLanguage": "<string>",
"displayName": "<string>",
"displayScript": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Country": "<string>",
"iso3Language": "<string>",
"language": "<string>",
"script": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"variant": "<string>"
},
"lastModified": "2023-11-07T05:31:56Z",
"length": 123,
"links": [
{
"params": {},
"rel": "<string>",
"rels": [
"<string>"
],
"title": "<string>",
"type": "<string>",
"uri": "<string>",
"uriBuilder": {}
}
],
"location": "<string>",
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"metadata": {
"empty": true
},
"status": 123,
"statusInfo": {
"family": "INFORMATIONAL",
"reasonPhrase": "<string>",
"statusCode": 123
},
"stringHeaders": {
"empty": true
}
}Your API key for Rhombus.
Authentication scheme indicator ("api-token").
9Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?