Interface: JobPayloadInput
An object describing the attributes of the source design.
Export
JobPayloadInput
Properties
checkReferences?
optional
checkReferences:boolean
true
- Instructs the system to check for references, and if any exist, download all referenced files. Setting this parameter totrue
is mandatory when translating source designs consisting of multiple files. For example, Autodesk Inventor assemblies.false
- (Default) Instructs the system not to check for references.
Memberof
JobPayloadInput
Defined in
aps-sdk-node/modelderivative/source/model/jobPayloadInput.ts:38
compressedUrn?
optional
compressedUrn:boolean
true
: The source design is compressed as a zip file. If set totrue
, you need to define therootFilename
.’false
: (Default) The source design is not compressed.
Memberof
JobPayloadInput
Defined in
aps-sdk-node/modelderivative/source/model/jobPayloadInput.ts:25
rootFilename?
optional
rootFilename:string
The file name of the top-level component of the source design. Mandatory ifcompressedUrn
is set totrue
.
Memberof
JobPayloadInput
Defined in
aps-sdk-node/modelderivative/source/model/jobPayloadInput.ts:31
urn
urn:
string
The URL safe Base64 encoded URN of the source design.
Note: The URN is returned as the objectID
once you complete uploading the source design to APS. This value must be converted to a Base64 (URL Safe) encoded <http://www.freeformatter.com/base64-encoder.html>
_ string before you can specify it for this attribute.
Memberof
JobPayloadInput
Defined in
aps-sdk-node/modelderivative/source/model/jobPayloadInput.ts:17