Class EntityApi

Methods

getAllDefectCategories

getAllDefectCategories(options?): Promise<DefectCategoryListApiResponse>
Retrieves a list of DefectCategories
Parameters
- Optionaloptions: IListRequestOptions
  Options to determine what DefectCategories to return
Returns Promise<DefectCategoryListApiResponse>

getAllDefects

getAllDefects(options?): Promise<DefectListApiResponse>
Retrieves a list of Defects
Parameters
- Optionaloptions: IListRequestOptions
  Options to determine what Defects to return
Returns Promise<DefectListApiResponse>

getAllFilters

getAllFilters(options?): Promise<FilterListApiResponse>
Retrieves a list of Filters
Parameters
- Optionaloptions: IListRequestOptions
  Options to determine what Filters to return
Returns Promise<FilterListApiResponse>

getAllLocalQueries

getAllLocalQueries(options?): Promise<LocalDatabaseQueryListApiResponse>
Retrieves a list of LocalQueries
Parameters
- Optionaloptions: IListRequestOptions
  Options to determine what LocalQueries to return
Returns Promise<LocalDatabaseQueryListApiResponse>

getAllParts

getAllParts(options?): Promise<PartListApiResponse>
Retrieves a list of Parts
Parameters
- Optionaloptions: IListRequestOptions
  Options to determine what Parts to return
Returns Promise<PartListApiResponse>

getAllProcesses

getAllProcesses(options?): Promise<ProcessListApiResponse>
Retrieves a list of Processes
Parameters
- Optionaloptions: IListRequestOptions
  Options to determine what Processes to return
Returns Promise<ProcessListApiResponse>

getAllSPCCharacteristics

getAllSPCCharacteristics(options?): Promise<SPCCharacteristicListApiResponse>
Retrieves a list of Characteristics
Parameters
- Optionaloptions: IListRequestOptions
  Options to determine what Characteristics to return
Returns Promise<SPCCharacteristicListApiResponse>

getAllSPCCharacteristicsForPart

getAllSPCCharacteristicsForPart(partId): Promise<SingleSPCCharacteristic[]>
Retrieves a list of all Characteristics on a given Part
Parameters
- partId: number
  The id of the Part to return Characteristics for
Returns Promise<SingleSPCCharacteristic[]>

getAllTags

getAllTags(options?): Promise<EntityTagListApiResponse>
Retrieves a list of Tags
Parameters
- Optionaloptions: IListRequestOptions
  Options to determine what Tags to return
Returns Promise<EntityTagListApiResponse>

getAllTraceability

getAllTraceability(options?): Promise<TraceabilityListApiResponse>
Retrieves a list of Traceability
Parameters
- Optionaloptions: IListRequestOptions
  Options to determine what Traceability to return
Returns Promise<TraceabilityListApiResponse>

getAllUnits

getAllUnits(options?): Promise<UnitListApiResponse>
Retrieves a list of Units
Parameters
- Optionaloptions: IListRequestOptions
  Options to determine what Units to return
Returns Promise<UnitListApiResponse>

getDefectById

getDefectById(id): Promise<SingleDefect>
Retrieves an existing Defect. Throws an error if the Defect does not exist.
Parameters
- id: number
  The id of the Defect to retrieve
Returns Promise<SingleDefect>

getDefectCategoryById

getDefectCategoryById(id): Promise<SingleDefectCategory>
Retrieves an existing DefectCategory. Throws an error if the DefectCategory does not exist.
Parameters
- id: number
  The id of the DefectCategory to retrieve
Returns Promise<SingleDefectCategory>

getDefectCategoryIdByName

getDefectCategoryIdByName(name): Promise<number>
Retrieves the ID of an existing DefectCategory by name. Throws an error if no DefectCategory exists with the given name.
Parameters
- name: string
  The name of the DefectCategory to retrieve
Returns Promise<number>

getDefectIdByName

getDefectIdByName(name): Promise<number>
Retrieves the ID of an existing Defect by name. Throws an error if no Defect exists with the given name.
Parameters
- name: string
  The name of the Defect to retrieve
Returns Promise<number>

getFilterById

getFilterById(id): Promise<SingleFilter>
Retrieves an existing Filter. Throws an error if the Filter does not exist.
Parameters
- id: number
  The id of the Filter to retrieve
Returns Promise<SingleFilter>

getFilterIdByName

getFilterIdByName(name): Promise<number>
Retrieves the ID of an existing Filter by name. Throws an error if no Filter exists with the given name.
Parameters
- name: string
  The name of the Filter to retrieve
Returns Promise<number>

getLocalQueryById

getLocalQueryById(id): Promise<SingleLocalDatabaseQuery>
Retrieves an existing Local Query. Throws an error if the Local Query does not exist.
Parameters
- id: number
  The id of the Local Query to retrieve
Returns Promise<SingleLocalDatabaseQuery>

getLocalQueryIdByName

getLocalQueryIdByName(name): Promise<number>
Retrieves the ID of an existing Local Query by name. Throws an error if no Local Query exists with the given name.
Parameters
- name: string
  The name of the Local Query to retrieve
Returns Promise<number>

getPartById

getPartById(id): Promise<SinglePart>
Retrieves an existing Part. Throws an error if the Part does not exist.
Parameters
- id: number
  The id of the Part to retrieve
Returns Promise<SinglePart>

getPartIdByName

getPartIdByName(name): Promise<number>
Retrieves the ID of an existing Part by name. Throws an error if no Part exists with the given name.
Parameters
- name: string
  The name of the Part to retrieve
Returns Promise<number>

getProcessById

getProcessById(id): Promise<SingleProcess>
Retrieves an existing Process. Throws an error if the Process does not exist.
Parameters
- id: number
  The id of the Process to retrieve
Returns Promise<SingleProcess>

getProcessByRevisionId

getProcessByRevisionId(id): Promise<SingleProcess>
Retrieves an existing Process by its revision ID. Throws an error if a Process with that revision does not exist.
Parameters
- id: number
  The id of the Process's revision to retrieve
Returns Promise<SingleProcess>

getProcessIdByName

getProcessIdByName(name): Promise<number>
Retrieves the ID of an existing Process by name. Throws an error if no Process exists with the given name.
Parameters
- name: string
  The name of the Process to retrieve
Returns Promise<number>

getSPCCharacteristicById

getSPCCharacteristicById(id): Promise<SingleSPCCharacteristic>
Retrieves an existing Characteristic. Throws an error if the Characteristic does not exist.
Parameters
- id: number
  The id of the Characteristic to retrieve
Returns Promise<SingleSPCCharacteristic>

getSPCCharacteristicByRevisionId

getSPCCharacteristicByRevisionId(id): Promise<SingleSPCCharacteristic>
Retrieves an existing Characteristic by its revision ID. Throws an error if a Characteristic with that revision does not exist.
Parameters
- id: number
  The id of the Characteristic's revision to retrieve
Returns Promise<SingleSPCCharacteristic>

getSPCCharacteristicIdByName

getSPCCharacteristicIdByName(name, partName): Promise<number>
Retrieves the ID of an existing Characteristic by name. Throws an error if no Characteristic exists with the given name.
Parameters
- name: string
  The name of the Characteristic to retrieve
- partName: string
  The name of the Part that is set on the Characteristic to retrieve
Returns Promise<number>

getTagById

getTagById(id): Promise<GSBaseEntity>
Retrieves an existing Tag. Throws an error if the Tag does not exist.
Parameters
- id: number
  The id of the Tag to retrieve
Returns Promise<GSBaseEntity>

getTagIdByName

getTagIdByName(name): Promise<number>
Retrieves the ID of an existing Tag by name. Throws an error if no Tag exists with the given name.
Parameters
- name: string
  The name of the Tag to retrieve
Returns Promise<number>

getTraceabilityById

getTraceabilityById(id): Promise<SingleTraceability>
Retrieves an existing Traceability. Throws an error if the Traceability does not exist.
Parameters
- id: number
  The id of the Traceability to retrieve
Returns Promise<SingleTraceability>

getTraceabilityIdByName

getTraceabilityIdByName(name): Promise<number>
Retrieves the ID of an existing Traceability by name. Throws an error if no Traceability exists with the given name.
Parameters
- name: string
  The name of the Traceability to retrieve
Returns Promise<number>

getUnitById

getUnitById(id): Promise<GSBaseEntity>
Retrieves an existing Unit. Throws an error if the Unit does not exist.
Parameters
- id: number
  The id of the Unit to retrieve
Returns Promise<GSBaseEntity>

getUnitIdByName

getUnitIdByName(name): Promise<number>
Retrieves the ID of an existing Unit by name. Throws an error if no Unit exists with the given name.
Parameters
- name: string
  The name of the Unit to retrieve
Returns Promise<number>