Home Search

DriveWorks Pro 22
SppGetSpecificationModelsByID

Send Feedback

SppGetSpecificationModelsByID

Returns a table of Specification models based on the Specification ID (Returns an error if the Specification is not found).

The Array has the headers: Name, Path, Type, Generating, Generated, Failed Count, Date Created and Tags (if applicable).

Syntax

SppGetSpecificationModelsByID(Specification ID, [Include Embedded Child Specification Models], [Include Tags])

Where:

Specification ID is the ID of the Specification to get the Array of models for.

Include Embedded Child Specification Models (optional) is True to include models in embedded Child Specifications, False to exclude.

Include Tags (optional) is True to include Tags information of the models, False to exclude. Tags are returned in an additional column, as a pipe-bar delimited list per model.

Examples

Example 1

Rule: Return an array of all models generated from a Specification without Tag information.

SppGetSpecificationModelsByID(17)

Or

SppGetSpecificationModelsByID(17,TRUE,FALSE)

Result:

This will return an Array containing information about Specification Models in the specified Specification.

{"Name","Path","Type","Generating","Generated","Failed Count","Date Created"; "Parent Assy 0017","C:\DriveWorks\Specifications\Parent Assy 0017.SLDASM","Assembly","FALSE","TRUE","0","17/12/2024 14:12:00"; "Bracket 0019","C:\DriveWorks\Specifications\Bracket 0019.SLDPRT","Part","FALSE","TRUE","0","17/12/2024 14:12:00"; "Mount 0018","C:\DriveWorks\Specifications\Mount 0018.SLDPRT","Part","FALSE","TRUE","0","17/12/2024 14:12:00"; "Guard 0020","C:\DriveWorks\Specifications\Guard 0020.SLDPRT","Part","FALSE","TRUE","0","17/12/2024 14:12:00"}

Result Viewed as a Table:

NamePathTypeGeneratingGeneratedFailed CountDate Created
Parent Assy 0017C:\DriveWorks\Specifications\Parent Assy 0017.SLDASMAssemblyFALSETRUE017/12/2024 14:12:00
Bracket 0019C:\DriveWorks\Specifications\Bracket 0019.SLDPRTPartFALSETRUE017/12/2024 14:12:00
Mount 0018C:\DriveWorks\Specifications\Mount 0018.SLDPRTPartFALSETRUE017/12/2024 14:12:00
Guard 0020C:\DriveWorks\Specifications\Guard 0020.SLDPRTPartFALSETRUE017/12/2024 14:12:00

Example 2

Rule: Return an array of only Parent models generated from a Specification without Tag information.

SppGetSpecificationModelsByID(17,FALSE,FALSE)

Result:

This will return an Array containing information about Specification Models in the specified Specification.

{"Name","Path","Type","Generating","Generated","Failed Count","Date Created","Tags"; "Parent Assy 0017","C:\DriveWorks\Specifications\Parent Assy 0017.SLDASM","Assembly","FALSE","TRUE","0","17/12/2024 14:12:00"}

Result Viewed as a Table:

NamePathTypeGeneratingGeneratedFailed CountDate Created
Parent Assy 0017C:\DriveWorks\Specifications\Parent Assy 0017.SLDASMAssemblyFALSETRUE017/12/2024 14:12:00

Example 3

Rule: Return an array of only Parent models generated from a Specification with Tag information.

SppGetSpecificationModelsByID(17,FALSE,TRUE)

Result:

This will return an Array containing information about Specification Models in the specified Specification.

{"Name","Path","Type","Generating","Generated","Failed Count","Date Created","Tags"; "Parent Assy 0017","C:\DriveWorks\Specifications\Parent Assy 0017.SLDASM","Assembly","FALSE","TRUE","0","17/12/2024 14:12:00","Low"}

Result Viewed as a Table:

NamePathTypeGeneratingGeneratedFailed CountDate CreatedTags
Parent Assy 0017C:\DriveWorks\Specifications\Parent Assy 0017.SLDASMAssemblyFALSETRUE017/12/2024 14:12:00Low

Example 4

Rule: Return an array of all models generated from a Specification with Tag information.

SppGetSpecificationModelsByID(17,TRUE,TRUE)

Result:

This will return an Array containing information about Specification Models in the specified Specification.

{"Name","Path","Type","Generating","Generated","Failed Count","Date Created","Tags"; "Parent Assy 0017","C:\DriveWorks\Specifications\Parent Assy 0017.SLDASM","Assembly","FALSE","TRUE","0","17/12/2024 14:12:00","Low"; "Bracket 0019","C:\DriveWorks\Specifications\Bracket 0019.SLDPRT","Part","FALSE","TRUE","0","17/12/2024 14:12:00","High"; "Mount 0018","C:\DriveWorks\Specifications\Mount 0018.SLDPRT","Part","FALSE","TRUE","0","17/12/2024 14:12:00","Medium"; "Guard 0020","C:\DriveWorks\Specifications\Guard 0020.SLDPRT","Part","FALSE","TRUE","0","17/12/2024 14:12:00","High"}

Result Viewed as a Table:

NamePathTypeGeneratingGeneratedFailed CountDate CreatedTags
Parent Assy 0017C:\DriveWorks\Specifications\Parent Assy 0017.SLDASMAssemblyFALSETRUE017/12/2024 14:12:00Low
Bracket 0019C:\DriveWorks\Specifications\Bracket 0019.SLDPRTPartFALSETRUE017/12/2024 14:12:00High
Mount 0018C:\DriveWorks\Specifications\Mount 0018.SLDPRTPartFALSETRUE017/12/2024 14:12:00Medium
Guard 0020C:\DriveWorks\Specifications\Guard 0020.SLDPRTPartFALSETRUE017/12/2024 14:12:00High

See Also

See Autopilot Tags for more information on Tags.