external Durst Workflow {Rest:API} description / v1.0 / 2019-02-14
Table of Contents
- Overview
- Paths
-
Definitions
- AddressApi
- ArticleApi
- ArticleCollectionApi
- CombinedTerm
- CustomerCompanyApi
- CustomerCompanyContactApi
- CustomerIndividualApi
- FileLinkApi
- HttpFileInfo
- JoinTable
- LocalFileInfo
- ManyToOneJoinTable
- MotifApi
- OneToManyJoinTable
- OrderByClause
- PrintOrderApi
- PrintOrderItemApi
- ProductionJobApi
- ReferencedAddressApi
- ReferencedArticleCollectionApi
- ReferencedColorPolicyApi
- ReferencedCustomerApi
- ReferencedCustomerCompanyContactApi
- ReferencedProcessingStepApi
- ReferencedSubstrateApi
- ReferencedSubstrateCategoryApi
- ReferencedSubstrateShapeApi
- SearchOptions
- SingleTerm
- SmbFileInfo
- SuccessInfoApi
- Term
- UserAccountApi
- Download
1. Overview
1.1. Version Information
Version: v1
1.2. URI scheme
Parameter | Value |
---|---|
Host | xxx.xxx.xxx.xxx.8081 |
BasePath | /pms |
Schemes | HTTP |
1.3. Tags
article-controller-api : Article Controller Api
customer-controller-api : Customer Controller Api
login-controller-api : Login Controller Api
print-order-controller-api : Print Order Controller Api
production-job-controller-api : Production Job Controller Api
2. Paths
POST /api/v1/articleCollections
2.1.1. Parameters
Type |
Name |
Description |
Schema |
---|---|---|---|
Body |
articleCollectionApi required |
articleCollectionApi |
2.1.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 | Created | ArticleCollectionApi |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
2.1.3. Consumes
application/json
2.1.4. Produces
*/*
2.1.5. Tags
article-controller-api
2.1.6. Example HTTP request
Request path
/api/v1/articleCollections
Request body
{
"name" : "Label 123",
"comment" : "string"
}
2.1.7. Example HTTP response
Response 201
{
"name" : "Label 123",
"comment" : "string"
}
POST /api/v1/articles
2.2.1. Parameters
Type |
Name |
Description |
Schema |
---|---|---|---|
Body |
articleApi required |
articleApi |
2.2.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 | Created | ArticleApi |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
2.2.3. Consumes
application/json
2.2.4. Produces
*/*
2.2.5. Tags
article-controller-api
2.2.6. Example HTTP request
Request path
/api/v1/articles
Request body
{
"name" : "Label 123",
"externalId" : "EXT-123",
"comment" : "string",
"widthMm" : 210.0,
"heightMm" : 297.0,
"pages" : 1,
"customerReference" : {
"id" : 0
},
"substrateReference" : {
"id" : 0
},
"articleCollectionReferenceList" : [ {
"id" : 0
} ],
"articleProcessingStepList" : [ {
"id" : 0
} ],
"pdfFileLink" : {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
},
"additionalFilesList" : [ {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
} ]
}
2.2.7. Example HTTP response
Response 201
{
"name" : "Label 123",
"externalId" : "EXT-123",
"comment" : "string",
"widthMm" : 210.0,
"heightMm" : 297.0,
"pages" : 1,
"customerReference" : {
"id" : 0
},
"substrateReference" : {
"id" : 0
},
"articleCollectionReferenceList" : [ {
"id" : 0
} ],
"articleProcessingStepList" : [ {
"id" : 0
} ],
"pdfFileLink" : {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
},
"additionalFilesList" : [ {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
} ]
}
POST /api/v1/customers/companies
2.3.1. Parameters
Type |
Name |
Description |
Schema |
---|---|---|---|
Body |
customerCompanyApi required |
customerCompanyApi |
2.3.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 | Created | CustomerCompanyApi |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
2.3.3. Consumes
application/json
2.3.4. Produces
*/*
2.3.5. Tags
customer-controller-api
2.3.6. Example HTTP request
Request path
/api/v1/customers/companies
Request body
{
"companyName" : "Acme Corporation",
"contactNumber" : "ABC-123",
"telephoneNumber" : "string",
"mobileNumber" : "string",
"email" : "[email protected]",
"fax" : "string",
"url" : "string",
"contacts" : [ {
"salutation" : "string",
"title" : "string",
"firstname" : "John",
"lastname" : "Doe",
"position" : "string",
"contactNumber" : "ABC-123",
"telephoneNumber" : "string",
"mobileNumber" : "string",
"email" : "[email protected]",
"fax" : "string",
"url" : "string"
} ],
"addresses" : [ {
"address1" : "Julius Durst Strasse 1",
"address2" : "string",
"address3" : "string",
"address4" : "string",
"addressType" : "string",
"zipCode" : "9900",
"place" : "Lienz",
"state" : "Austria",
"defaultAddress" : true
} ]
}
2.3.7. Example HTTP response
Response 201
{
"companyName" : "Acme Corporation",
"contactNumber" : "ABC-123",
"telephoneNumber" : "string",
"mobileNumber" : "string",
"email" : "[email protected]",
"fax" : "string",
"url" : "string",
"contacts" : [ {
"salutation" : "string",
"title" : "string",
"firstname" : "John",
"lastname" : "Doe",
"position" : "string",
"contactNumber" : "ABC-123",
"telephoneNumber" : "string",
"mobileNumber" : "string",
"email" : "[email protected]",
"fax" : "string",
"url" : "string"
} ],
"addresses" : [ {
"address1" : "Julius Durst Strasse 1",
"address2" : "string",
"address3" : "string",
"address4" : "string",
"addressType" : "string",
"zipCode" : "9900",
"place" : "Lienz",
"state" : "Austria",
"defaultAddress" : true
} ]
}
POST /api/v1/customers/individuals
2.4.1. Parameters
Type |
Name |
Description |
Schema |
---|---|---|---|
Body |
customerIndividualApi required |
customerIndividualApi |
2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 | Created | CustomerIndividualApi |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
2.4.3. Consumes
application/json
2.4.4. Produces
*/*
2.4.5. Tags
customer-controller-api
2.4.6. Example HTTP request
Request path
/api/v1/customers/individuals
Request body
{
"salutation" : "string",
"title" : "string",
"firstname" : "John",
"lastname" : "Doe",
"position" : "string",
"contactNumber" : "ABC-123",
"telephoneNumber" : "string",
"mobileNumber" : "string",
"email" : "[email protected]",
"fax" : "string",
"url" : "string",
"addresses" : [ {
"address1" : "Julius Durst Strasse 1",
"address2" : "string",
"address3" : "string",
"address4" : "string",
"addressType" : "string",
"zipCode" : "9900",
"place" : "Lienz",
"state" : "Austria",
"defaultAddress" : true
} ]
}
2.4.7. Example HTTP response
Response 201
{
"salutation" : "string",
"title" : "string",
"firstname" : "John",
"lastname" : "Doe",
"position" : "string",
"contactNumber" : "ABC-123",
"telephoneNumber" : "string",
"mobileNumber" : "string",
"email" : "[email protected]",
"fax" : "string",
"url" : "string",
"addresses" : [ {
"address1" : "Julius Durst Strasse 1",
"address2" : "string",
"address3" : "string",
"address4" : "string",
"addressType" : "string",
"zipCode" : "9900",
"place" : "Lienz",
"state" : "Austria",
"defaultAddress" : true
} ]
}
GET /api/v1/login
2.5.1. Parameters
Type |
Name |
Description |
Schema |
---|---|---|---|
Query |
logoutID optional |
logoutID | string |
Query |
password required |
password | string |
Query |
username required |
username | string |
2.5.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Created | UserAccountApi |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
2.5.3. Produces
*/*
2.5.4. Tags
login-controller-api
2.5.5. Example HTTP request
Request path
/api/v1/login?password=string&username=string
2.5.6. Example HTTP response
Response 200
{
"activeUntil" : "string",
"id" : "string",
"username" : "string"
}
POST /api/v1/printOrders
2.6.1. Parameters
Type |
Name |
Description |
Schema |
---|---|---|---|
Body |
printOrderApi required |
printOrderApi |
2.6.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 | Created | PrintOrderApi |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
2.6.3. Consumes
application/json
2.6.4. Produces
*/*
2.6.5. Tags
print-order-controller-api
2.6.6. Example HTTP request
Request path
/api/v1/printOrders
Request body
{
"name" : "My print order 123",
"externalId" : "EXT-123",
"comment" : "string",
"orderNumber" : "ABC-123",
"customerReference" : {
"id" : 0
},
"invoiceAddressReference" : {
"id" : 0
},
"printOrderItems" : [ {
"name" : "Label 123",
"comment" : "string",
"deliveryDate" : "string",
"substrateCategoryReference" : {
"id" : 0
},
"substrateReference" : {
"id" : 0
},
"deliveryAddressReference" : {
"id" : 0
},
"deliveryContactReference" : {
"id" : 0
},
"motifs" : [ {
"name" : "Label 123",
"comment" : "string",
"widthMm" : 210.0,
"heightMm" : 297.0,
"pages" : 1,
"numberCopies" : 100,
"windingTypeKey" : "INSIDE",
"orientationTypeKey" : "TOP",
"colorPolicyReference" : {
"id" : 0
},
"pdfFileLink" : {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
},
"additionalFilesList" : [ {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
} ]
} ]
} ]
}
2.6.7. Example HTTP response
Response 201
{
"name" : "My print order 123",
"externalId" : "EXT-123",
"comment" : "string",
"orderNumber" : "ABC-123",
"customerReference" : {
"id" : 0
},
"invoiceAddressReference" : {
"id" : 0
},
"printOrderItems" : [ {
"name" : "Label 123",
"comment" : "string",
"deliveryDate" : "string",
"substrateCategoryReference" : {
"id" : 0
},
"substrateReference" : {
"id" : 0
},
"deliveryAddressReference" : {
"id" : 0
},
"deliveryContactReference" : {
"id" : 0
},
"motifs" : [ {
"name" : "Label 123",
"comment" : "string",
"widthMm" : 210.0,
"heightMm" : 297.0,
"pages" : 1,
"numberCopies" : 100,
"windingTypeKey" : "INSIDE",
"orientationTypeKey" : "TOP",
"colorPolicyReference" : {
"id" : 0
},
"pdfFileLink" : {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
},
"additionalFilesList" : [ {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
} ]
} ]
} ]
}
GET /api/v1/productionJob/{id}/sendToPrinter
2.7.1. Parameters
Type |
Name |
Description |
Schema |
---|---|---|---|
Body |
id required |
id | integer (int32) |
2.7.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | OK | SuccessInfoApi |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
2.7.3. Produces
*/*
2.7.4. Tags
production-job--controller-api
2.7.5. Example HTTP request
Request path
/api/v1/productionJob/0/sendToPrinter
2.7.6. Example HTTP response
Response 200
{
"message" : "string"
}
POST /api/v1/productionJobs
2.8.1. Parameters
Type |
Name |
Description |
Schema |
---|---|---|---|
Body |
productionJobApi required |
productionJobApi |
2.8.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 | Created | ProductionJobApi |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
2.8.3. Consumes
application/json
2.8.4. Produces
*/*
2.8.5. Tags
production-job-controller-api
2.8.6. Example HTTP request
Request path
/api/v1/productionJobs
Request body
{
"name" : "My test job 123",
"externalId" : "EXT-123",
"comment" : "comment for test job",
"shippingDate" : "2018-01-01",
"productionDate" : "2018-01-01T12:00:00Z",
"referencedColorPolicy" : {
"id" : 0
},
"referencedSubstrateShape" : {
"id" : 0
},
"motifList" : [ {
"name" : "Label 123",
"comment" : "string",
"widthMm" : 210.0,
"heightMm" : 297.0,
"pages" : 1,
"numberCopies" : 100,
"windingTypeKey" : "INSIDE",
"orientationTypeKey" : "TOP",
"colorPolicyReference" : {
"id" : 0
},
"pdfFileLink" : {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
},
"additionalFilesList" : [ {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
} ]
} ]
}
2.8.7. Example HTTP response
Response 201
{
"name" : "My test job 123",
"externalId" : "EXT-123",
"comment" : "comment for test job",
"shippingDate" : "2018-01-01",
"productionDate" : "2018-01-01T12:00:00Z",
"referencedColorPolicy" : {
"id" : 0
},
"referencedSubstrateShape" : {
"id" : 0
},
"motifList" : [ {
"name" : "Label 123",
"comment" : "string",
"widthMm" : 210.0,
"heightMm" : 297.0,
"pages" : 1,
"numberCopies" : 100,
"windingTypeKey" : "INSIDE",
"orientationTypeKey" : "TOP",
"colorPolicyReference" : {
"id" : 0
},
"pdfFileLink" : {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
},
"additionalFilesList" : [ {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
} ]
} ]
}
POST /api/v1/productionJobs/search
2.9.1. Parameters
Type |
Name |
Description |
Schema |
---|---|---|---|
Body |
bla required |
bla |
2.9.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | OK | <ProductionJobApi> array |
201 | Created | No Content |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
2.9.3. Consumes
application/json
2.9.4. Produces
*/*
2.9.5. Tags
production-job-controller-api
2.9.6. Example HTTP request
Request path
/api/v1/productionJobs/search
Request body
{
"criteria" : { },
"fields" : [ "string" ],
"flattenedJoins" : [ {
"alias" : "string",
"joins" : [ {
"alias" : "string",
"joins" : [ "..." ],
"manyToOne" : true,
"oneToMany" : true,
"parentJoin" : "...",
"referenceColumnName" : "string",
"tableName" : "string",
"type" : "string"
} ],
"manyToOne" : true,
"oneToMany" : true,
"parentJoin" : "...",
"referenceColumnName" : "string",
"tableName" : "string",
"type" : "string"
} ],
"joins" : [ "..." ],
"limit" : 0,
"orderBy" : {
"string" : "string"
},
"orderByClause" : [ {
"alias" : "string",
"orderType" : "string",
"property" : "string"
} ],
"page" : 0
}
2.9.7. Example HTTP response
Response 200
[ {
"name" : "My test job 123",
"externalId" : "EXT-123",
"comment" : "comment for test job",
"shippingDate" : "2018-01-01",
"productionDate" : "2018-01-01T12:00:00Z",
"referencedColorPolicy" : {
"id" : 0
},
"referencedSubstrateShape" : {
"id" : 0
},
"motifList" : [ {
"name" : "Label 123",
"comment" : "string",
"widthMm" : 210.0,
"heightMm" : 297.0,
"pages" : 1,
"numberCopies" : 100,
"windingTypeKey" : "INSIDE",
"orientationTypeKey" : "TOP",
"colorPolicyReference" : {
"id" : 0
},
"pdfFileLink" : {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
},
"additionalFilesList" : [ {
"fileInfoType" : "string",
"httpFileInfo" : {
"host" : "string",
"path" : "string",
"port" : "string"
},
"localFileInfo" : {
"fileUri" : "string"
},
"smbFileInfo" : {
"host" : "string",
"path" : "string"
}
} ]
} ]
} ]
3. Definitions
3.1. AddressApi
Name | Description | Schema |
---|---|---|
address1 required | Example: „Julius Durst Straße 1" | string |
address2 optional |
Example: „string" | string |
address3 optional |
Example: „string" |
string |
address4 optional |
Example: „string" |
string |
addressType required | Example: „string" |
enum (DELIVERY_ADDRESS, INVOICE_ADDRESS) |
defaultAddress optional | Example: true | boolean |
place required | Example: „Lienz" |
string |
state required | Example: „Austria" |
string |
zipCode required | Example: „9900" |
string |
3.2. ArticleApi
Name | Description | Schema |
---|---|---|
additionalFilesList optional | Example: [ „FileLinkApi“ ] | < FileLinkApi > array |
articleCollectionReferenceList optional | Example: [ „ReferencedArticleCollectionApi“ ] |
< ReferencedArticleCollectionApi > array |
articleProcessingStepList optional | Example: [ „ReferencedProcessingStepApi“ ] |
< ReferencedProcessingStepApi > array |
comment optional | Example: „string" |
string |
customerReference optional | Example: „ReferencedCustomerApi“ |
ReferencedCustomerApi |
externalId required | Example: „EXT-123" | string |
heightMm optional | Example: 297.0 |
number (double) |
name required | Example: „Label 123" |
string |
pages optional | Example: 1 |
integer (int32) |
pdfFileLink optional | Example: FileLinkApi |
FileLinkApi |
substrateReference optional | Example: ReferencedSubstrateApi |
ReferencedSubstrateApi |
widthMm optional | Example: 210.0 | number (double) |
3.3. ArticleCollectionApi
Name | Description | Schema |
---|---|---|
comment optional | Example: „string" | string |
name required | Example: „Label 123" | string |
3.4. CombinedTerm
Polymorphism : Composition
3.5. CustomerCompanyApi
Name | Description | Schema |
---|---|---|
addresses optional | Example: [ „AddressApi“ ] | < AddressApi > array |
companyName required | Example: „ACME Corporation" | string |
contactNumber optional | Example: „ABC-123" |
string |
contacts optional | Example: [ „CustomerCompanyContactApi“ ] |
< CustomerCompanyContactAp > array |
email optional | Example: „[email protected]" |
string |
fax optional | Example: „string" |
string |
mobileNumber optional | Example: „string" |
string |
telephoneNumber optional | Example: „string" |
string |
url optional | Example: „string" |
string |
3.6. CustomerCompanyContactApi
Name | Description | Schema |
---|---|---|
contactNumber optional | Example: „ABC-123" | string |
email optional | Example: „[email protected]" | string |
fax optional | Example: „string" |
string |
firstname required | Example: „John" |
string |
lastname required | Example: „Doe" |
string |
mobileNumber optional | Example: „string" | string |
position optional | Example: „string" |
string |
salutation optional | Example: „string" |
string |
telephoneNumber optional | Example: „string" |
string |
title optional | Example: „string" |
string |
url optional | Example: „string" |
string |
3.7. CustomerIndividualApi
Name | Description | Schema |
---|---|---|
address optional | Example: [ „AddressApi“ ] | < AddressApi > array |
contactNumber optional | Example: „ABC-123" | string |
email optional | Example: „[email protected]" |
string |
fax optional | Example: „string" |
string |
firstname required | Example: „John" |
string |
lastname required | Example: „Doe" | string |
mobileNumber optional | Example: „string" |
string |
position optional | Example: „string" |
string |
salutation optional | Example: „string" |
string |
telephoneNumber optional | Example: „string" |
string |
title optional | Example: „string" |
string |
url optional | Example: „string" |
string |
3.8. FileLinkApi
Name | Description | Schema |
---|---|---|
fileInfoType optional | Example: „string" | enum (HTTP, SMB, LOCAL) |
httpFileInfo optional | Example: HttpFileInfo |
HttpFileInfo |
localFileInfo optional | Example: LocalFileInfo |
LocalFileInfo |
smbFileInfo optional | Example: SmbFileInfo |
SmbFileInfo |
3.9. HttpFileInfo
Name | Description | Schema |
---|---|---|
host optional | Example: „string" |
string |
path optional | Example: „string" | string |
port optional | Example: „string" |
string |
3.10. JoinTable
Name | Description | Schema |
---|---|---|
alias optional | Example: „Julius Durst Straße 1" | string |
joins optional | Example: [ „JoinTable“ ] | < JoinTable > array |
manyToOne optional |
Example: true |
boolean |
oneToMany optional |
Example: true |
boolean |
parentJoin optional | Example: JoinTable |
JoinTable |
referenceColumnName optional | Example: „string" | string |
tableName optional | Example: „string" |
string |
type optional | Example: „string" |
string |
3.11. LocalFileInfo
Name | Description | Schema |
---|---|---|
fileUri optional | Example: „string" | string |
3.12. ManyToOneJoinTable
Polymorphism : Composition
Name | Description | Schema |
---|---|---|
alias optional | Example: „string" | string |
foreignKeyColumn optional |
Example: [ foreignKeyColumnConfiguration ] |
ForeignKeyColumnConfiguration |
joins optional |
Example: [ „JoinTable“ ] |
< JoinTable > array |
manyToOne optional |
Example: true |
boolean |
oneToMany optional | Example: true |
boolean |
parentJoin optional | Example: JoinTable |
JoinTable |
referenceColumnName optional | Example: „string" |
string |
tableName optional | Example: „string" |
string |
type optional | Example: „string" |
string |
3.13. MotifApi
Name | Description | Schema |
---|---|---|
additionalFileList optional | Example: [ „FileLinkApi" ] | < FileLinkApi > array |
colorPolicyReference optional |
Example: ReferencedColorPolicyApi |
ReferencedColorPolicyApi |
comment optional |
Example: „string" |
string |
heightMm optional |
Example: 297.0 |
number (double) |
name required | Example: „Label 123" |
string |
numberCopies optional | Example: 100 | integer (int32) |
orientationTypeKey optional | Example: „TOP" |
enum (TOP, BOTTOM, RIGHT, LEFT) |
pages optional | Example: 1 |
integer (int32) |
pdfFileLink optional | Example: FileLinkApi |
FileLinkApi |
widthMm optional |
Example: 210.0 | number (double) |
windingTypeKey optional | Example: „INSIDE" | enum (INSIDE, OUTSIDE) |
3.14. OneToManyJoinTable
Polymorphism : Composition
Name | Description | Schema |
---|---|---|
alias optional | Example: „string" |
string |
backReference optional |
Example: „string" | string |
joins optional |
Example: [ foreignkeycolumnconfiguration ] |
Foreignkeycolumnconfiguration |
manyToOne optional |
Example: true |
boolean |
oneToMany optional | Example: true |
boolean |
parentJoin optional | Example: JoinTable |
JoinTable |
referenceColumnName optional | Example: „string" |
string |
tableName optional | Example: „string" |
string |
type optional | Example: „string" |
string |
3.15. OrderByClause
Name | Description | Schema |
---|---|---|
alias optional |
Example: „string" | string |
orderType optional |
Example: „string" |
enum (ASC, DESC) |
property optional |
Example: „string" |
string |
3.16. PrintOrderApi
Name | Description | Schema |
---|---|---|
comment optional | Example: „string" |
string |
customerReference optional |
Example: ReferencedCustomerApi |
ReferencedCustomerApi |
externalId required |
Example: „EXT-123" |
string |
invoiceAddressReference optional |
Example: ReferencedAddressApi |
ReferencedAddressApi |
name required | Example: „My print order 123" |
string |
orderNumber optional | Example: „ABC-123" | string |
printOrderItems optional | Example: [ „PrintOrderItemApi“ ] |
< PrintOrderItemApi > array |
3.17. PrintOrderItemApi
Name | Description | Schema |
---|---|---|
comment optional | Example: „string" | string |
deliveryAddressReference optional |
Example: ReferencedAddressApi |
ReferencedAddressApi |
deliveryContactReference optional |
Example: ReferencedCustomerCompanyContactApi |
ReferencedCustomerCompanyContactApi |
deliveryDate optional |
Example: „string" |
string |
motifs required | Example: [ „MotifApi“ ] |
< MotifApi > array |
name required | Example: „Label 123" | string |
substrateCategoryReference required | Example: ReferencedSubstrateCategoryApi |
ReferencedSubstrateCategoryApi |
substrateReference required | Example: ReferencedSubstrateApi |
ReferencedSubstrateApi |
3.18. ProductionJobApi
Name | Description | Schema |
---|---|---|
comment optional | Example: „comment for Job" | string |
externalId required |
Example: „EXT-123" | string |
motifList optional |
Example: [ „MotifApi“ ] |
< MotifApi > array |
name required |
Example: „My Job 123" |
string |
productionDate required | Example: „2010-02-23T12:00:00Z" |
string (date-time) |
referencedColorPolicy optional | Example: ReferencedColorPolicyApi |
ReferencedColorPolicyApi |
referencedSubstrateShape optional | Example: ReferencedSubstrateShapeApi |
ReferencedSubstrateShapeApi |
shippingDate required | Example: „2019-02-23" |
string (date) |
3.19. ReferencedAddressApi
Name | Description | Schema |
---|---|---|
id optional | Example: 0 | integer (int32) |
3.20. ReferencedArticleCollectionApi
Name | Description | Schema |
---|---|---|
id optional | Example: 0 | integer (int32) |
3.21. ReferencedColorPolicyApi
Name | Description | Schema |
---|---|---|
id optional |
Example: 0 | integer (int32) |
3.22. ReferencedCustomerApi
Name | Description | Schema |
---|---|---|
id optional |
Example: 0 | integer (int32) |
3.23. ReferencedCustomerCompanyContactApi
Name | Description | Schema |
---|---|---|
id optional |
Example: 0 | integer (int32) |
3.24. ReferencedProcessingStepApi
Name | Description | Schema |
---|---|---|
id optional |
Example: 0 | integer (int32) |
3.25. ReferencedSubstrateApi
Name | Description | Schema |
---|---|---|
id optional |
Example: 0 | integer (int32) |
3.26. ReferencedSubstrateCategoryApi
Name | Description | Schema |
---|---|---|
id optional |
Example: 0 | integer (int32) |
3.27. ReferencedSubstrateShapeApi
Name | Description | Schema |
---|---|---|
id optional |
Example: 0 | integer (int32) |
3.28. SearchOptions
Name | Description | Schema |
---|---|---|
criteria optional |
Example: Term |
Term |
fields optional |
Example: [ „string“ ] |
< string > array |
flattenedJoins optional |
Example: [ „JoinTable“ ] |
< JoinTable > array |
joins optional | Example: [ „JoinTable“ ] |
< JoinTable > array |
limit optional | Example: 0 | integer (int32) |
orderBy optional | Example: { „string“ : „string“ } |
< string, string > map |
orderByClause optional | Example: [ „OrderByClause“ ] |
< OrderByClause > array |
page optional | Example: 0 |
integer (int32) |
3.29. SingleTerm
Polymorphism : Composition
Name | Description | Schema |
---|---|---|
alias optional |
Example: „string" | string |
column optional |
Example: columnconfiguration |
ColumnConfiguration |
operator optional |
Example: „string" |
enum (EQUAL, NOT_EQUAL, EQUAL_WITH_CASE, LIKE, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, IS_NULL, IS_NOT_NULL, IN) |
paramIndex optional | Example: 0 |
integer (int32) |
property optional | Example: „string" |
string |
propertyPrefix optional | Example: „string" |
string |
value optional | Example: „object" |
objekct |
3.30. SmbFileInfo
Name | Description | Schema |
---|---|---|
host optional |
Example: „string" | string |
path optional |
Example: „string" |
string |
3.31. SuccessInfoApi
Name | Description | Schema |
---|---|---|
message optional |
Example: „string" | string |
3.32. Term
Type : object
3.33. UserAccountApi
Name | Description | Schema |
---|---|---|
activeUntil optional |
Example: „string" | string (date) |
id optional |
Example: „string" |
string |
username optional |
Example: „string" |
string |