typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (DS) and the ID.

name

-

-

description

-

internalPartNumber

-

links

An array of encoded JSON objects in the format of Source Documents.

DrugSubstanceFlows[flow=Output].*

Drug Substance objects are limited to flow of output and can only have one output.

DrugSubstanceToFQAs[*]

An array of encoded JSON objects representing links to FQAs and IQAs.

tags

An array of encoded JSON objects.

drugSubstanceType

-

form

-

density

-

densityConditions

-

chemicalStructure

-

empiricalFormula

-

molecularWeight

-

chemicalNameCAS

-

chemicalNameIUPAC

-

otherNames

-

innUsan

-

casRegistryNumber

-

compendialStandard

-

certificateOfAnalysis

Boolean

propertiesLinks

Response is an array of encoded JSON objects in the format of Source Documents.

referencesLinks

Response is an array of encoded JSON objects in the format of Source Documents.

DrugSubstanceVersions[<version ID>].majorVersion + “.” + DrugSubstanceVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

Use LastVersionId or LastApprovedVersionId to access the array.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (DP) and the ID.

name

-

-

description

-

internalPartNumber

-

links

An array of encoded JSON objects in the format of Source Documents.

DrugSubstanceFlows[flow=Output].*

Drug Substance objects are limited to flow of output and can only have one output.

DrugSubstanceToFQAs[*]

An array of encoded JSON objects representing links to FQAs and IQAs.

tags

An array of encoded JSON objects.

drugSubstanceType

-

form

-

density

-

densityConditions

-

chemicalStructure

-

empiricalFormula

-

molecularWeight

-

chemicalNameCAS

-

chemicalNameIUPAC

-

otherNames

-

innUsan

-

casRegistryNumber

-

compendialStandard

-

certificateOfAnalysis

Boolean

propertiesLinks

Response is an array of encoded JSON objects in the format of Source Documents.

referencesLinks

Response is an array of encoded JSON objects in the format of Source Documents.

DrugProductVersions[<version ID>].majorVersion + “.” + DrugProductVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

Use LastVersionId or LastApprovedVersionId to access the array.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (FQA) and the ID.

name

-

type

-

scope

-

category

-

description

-

TPPSections[*]

Array of JSON objects.

GeneralAttributes[*]

Field depends on the Project’s risk assessment type.

FPAToGeneralAttributeRisks

Field depends on the Project’s risk assessment type.

riskInfo.Criticality.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.criticality.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.Criticality.riskLabel

-

riskInfo.Criticality.scoreLabel

-

recommendedActions

-

scaleDependent

-

scaleJustification

-

riskLinks OR

FPAToGeneralAttributeRisks[*].links

Response is an array of encoded JSON objects in the format of Source Documents.

The riskLinks object is used when the AppliesTo field isn’t associated with relationships (e.g., Attribute to IQA).

If AppliesTo references a relationship, the response object will be included in the relationship array's links object.

When one link is associated (via AppliesTo) with different model types, then the link is returned in both objects.

dataSpace

-

measure

-

measurementUnits

-

lowerLimit

Objects at the base come from the Primary Reporting Criteria.

target

Objects at the base come from the Primary Reporting Criteria.

upperLimit

Objects at the base come from the Primary Reporting Criteria.

ControlMethods[*].name

Response is an array of objects containing summary Control Method details.

samplingPlan

-

targetJustification

-

acceptanceCriteriaLinks

An array of encoded JSON objects in the format of Source Documents.

capabilityRisk OR

riskInfo.”Capability Risk”.riskScore
riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The capabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskinfo.”Process Risk”.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

estimatedSampleSize

-

capabilityJustification

-

detectabilityRisk ||

riskInfo.”Detectability Risk”.value

riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The detectabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskInfo.RPN.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

-

riskInfo.RPN.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

controlStrategy

An array of Strings.

CCP

-

controlStrategyJustification

-

riskControlLinks

An array of encoded JSON objects in the format of Source Documents.

referencesLinks

An array of encoded JSON objects in the format of Source Documents.

FPAVersions[<version ID>].majorVersion + “.” + FPAVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (FPA) and the ID.

name

-

type

-

scope

-

category

-

description

-

TPPSections[*]

Array of JSON objects.

GeneralAttributes[*]

Field depends on the Project’s risk assessment type.

FQAToGeneralAttributeRisks

Field depends on the Project’s risk assessment type.

riskInfo.Criticality.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.criticality.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.Criticality.riskLabel

-

riskInfo.Criticality.scoreLabel

-

recommendedActions

-

scaleDependent

-

scaleJustification

-

riskLinks OR

FQAToGeneralAttributeRisks[*].links

Response is an array of encoded JSON objects in the format of Source Documents.

The riskLinks object is used when the AppliesTo field isn’t associated with relationships (e.g., Attribute to IQA).

If AppliesTo references a relationship, the response object will be included in the relationship array's links object.

When one link is associated (via AppliesTo) with different model types, then the link is returned in both objects.

dataSpace

-

measure

-

measurementUnits

-

lowerLimit

Objects at the base come from the Primary Reporting Criteria.

target

Objects at the base come from the Primary Reporting Criteria.

upperLimit

Objects at the base come from the Primary Reporting Criteria.

ControlMethods[*].name

Response is an array of objects containing summary Control Method details.

samplingPlan

-

targetJustification

-

acceptanceCriteriaLinks

An array of encoded JSON objects in the format of Source Documents.

capabilityRisk OR

riskInfo.”Capability Risk”.riskScore
riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The capabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskinfo.”Process Risk”.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

estimatedSampleSize

-

capabilityJustification

-

detectabilityRisk ||

riskInfo.”Detectability Risk”.value

riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The detectabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskInfo.RPN.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

-

riskInfo.RPN.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

controlStrategy

An array of Strings.

CCP

-

controlStrategyJustification

-

riskControlLinks

An array of encoded JSON objects in the format of Source Documents.

referencesLinks

An array of encoded JSON objects in the format of Source Documents.

FQAVersions[<version ID>].majorVersion + “.” + FQAVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

id

The ID field in the UI is a concatenation of the TypeCode (UO) and the ID.

name

-

description

-

PreviousUnitId

ID is returned; name must be looked up.

Supplier.name

Supplier Object is in the return.

input

This field is being depreciated in favor of new Input/Output Materials.

output

This field is being depreciated in favor of new Input/Output Materials.

links

An array of encoded JSON objects in the format of Source Documents.

tags

An array of encoded JSON objects.

UnitOperationVersions[<version ID>].majorVersion + “.” + UnitOperationVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

Use LastVersionId or LastApprovedVersionId to access the array.

id

The ID field in the UI is a concatenation of the TypeCode (PP) and the ID.

name

-

description

-

UnitOperationId

ID is returned; the name must be looked up.

PreviousStepId

ID is returned; the name must be looked up.

links

Response is an array of encoded JSON objects in the format of Source Documents.

tags

An array of encoded JSON objects.

StepVersions[<version ID>].majorVersion + “.” + StepVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

Use LastVersionId or LastApprovedVersionId to access the array.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (PP) and the ID.

name

-

ProcessComponentId OR MaterialId

A parameter can only belong to one. ID is returned; the name must be looked up.

The parents array can also be used for lookup.

UnitOperation.name OR

UnitOperationId

Other fields exist, including UnitOperationId and the parents array.

Step.name OR

StepId

Other fields exist, including UnitOperationId and the parents array.

type

-

description

-

potentialFailureModes

-

ProcessParameterToIQAs[*].name

ProcessParameterToIPAs[*].name

ProcessParameterToFQAs[*].name

ProcessParameterToFPAs[*].name

The user interface groups risk links together; however, the API response returns them as separate arrays according to their model.

riskInfo.Criticality.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.criticality.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.Criticality.riskLabel

-

riskInfo.Criticality.scoreLabel

-

recommendedActions

-

scaleDependent

-

scaleJustification

-

riskLinks OR

ProcessParameterToIQAs[*].links

ProcessParameterToIPAs[*].links

ProcessParameterToFQAs[*].links

ProcessParameterToFPAs[*].links

Response is an array of encoded JSON objects in the format of Source Documents.

The riskLinks object is used when the AppliesTo field isn’t associated with relationships (e.g., Process Parameter to IQA).

If AppliesTo references a relationship, the response object will be included in the relationship array's links object.

When one link is associated (via AppliesTo) with different model types, then the link is returned in both objects.

dataSpace

-

measure

-

measurementUnits

-

lowerLimit

Objects at the base come from the Primary Reporting Criteria.

target

Objects at the base come from the Primary Reporting Criteria.

upperLimit

Objects at the base come from the Primary Reporting Criteria.

ControlMethods[*].name

Response is an array of objects containing summary Control Method details.

samplingPlan

-

targetJustification

-

lowerOperatingLimit

-

upperOperatingLimit

-

acceptanceCriteriaLinks

An array of encoded JSON objects in the format of Source Documents.

capabilityRisk OR

riskInfo.”Capability Risk”.riskScore
riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The capabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskinfo.”Process Risk”.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

estimatedSampleSize

-

capabilityJustification

-

detectabilityRisk ||

riskInfo.”Detectability Risk”.value

riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The detectabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskInfo.RPN.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

-

riskInfo.RPN.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

controlStrategy

An array of Strings.

CCP

-

controlStrategyJustification

-

riskControlLinks

An array of encoded JSON objects in the format of Source Documents.

referencesLinks

An array of encoded JSON objects in the format of Source Documents.

ProcessParameterVersions[<version ID>].majorVersion + “.” + ProcessParameterVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

Use LastVersionId or LastApprovedVersionId to access the array.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (PRC) and the ID.

name

-

UnitOperations[*].name

Process Component records can be shared.

UnitOperations[*].name

-

type

-

function

certificateOfAnalysis

Boolean

description

-

links

Response is an array of encoded JSON objects in the format of Source Documents.

SupplierId

Supplier.name

Supplier object included in response.

componentQualified

-

partNumber

-

internalPartNumber

-

effectiveDate

-

expirationDate

-

componentQualificationLinks

Response is an array of encoded JSON objects in the format of Source Documents.

acceptanceTesting

-

qualificationStatus

-

unitId

-

unitQualificationLinks

-

drugProductContact

-

contactRisk

-

contactRiskJustification

-

cleaningValidation

-

sterilizationValidation

-

componentRiskLinks

Response is an array of encoded JSON objects in the format of Source Documents.

referencesLinks

Response is an array of encoded JSON objects in the format of Source Documents.

ProcessComponentVersions[<version ID>].majorVersion + “.” + ProcessComponentVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

Use LastVersionId or LastApprovedVersionId to access the array.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (MA) and the ID.

name

-

function

-

use

-

category

SeeMaterials & Process Components | Material Categories for Material Categories.

description

MaterialFlows[*].flow

MaterialFlows is an array of Objects representing the Material as it exists in different parts of the process.

SeeMaterials & Process Components | Input, Intermediate, and Output Materials for more details.

links

Response is an array of encoded JSON objects in the format of Source Documents.

descriptiveUnitAbsolute

-

quantityAbsolute

-

quantityRelative

-

quantityPerDose

-

formulationQuantityLinks

-

Supplier.name

Supplier object available on the root object.

materialQualified

-

gmp

-

partNumber

-

internalPartNumber

-

effectiveDate

-

expirationDate

-

qualificationLinks

Response is an array of encoded JSON objects in the format of Source Documents.

regulatoryFiling

-

referenceNumber

-

authorizationLetter

-

regulatoryLinks

Response is an array of encoded JSON objects in the format of Source Documents.

drugSubstanceType

-

form

-

density

-

densityConditions

-

chemicalStructure

-

empiricalFormula

-

molecularWeight

-

chemicalNameCAS

-

chemicalNameIUPAC

-

otherNames

-

innUsan

-

casRegistryNumber

-

compendialStandard

-

certificateOfAnalysis

Boolean

propertiesLinks

Response is an array of encoded JSON objects in the format of Source Documents.

referencesLinks

Response is an array of encoded JSON objects in the format of Source Documents.

MaterialVersions[<version ID>].majorVersion + “.” + MaterialVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

Use LastVersionId or LastApprovedVersionId to access the array.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (MA) and the ID.

name

-

ProcessComponentId OR MaterialId

An Attribute can only belong to one. ID is returned; the name must be looked up.

The parents array can also be used for lookup.

UnitOperation.name

Other fields exist, including UnitOperationId and the parents array.

StepId

Other fields exist, including UnitOperationId and the parents array.

type

-

description

-

potentialFailureModes

-

MaterialAttributeToFQAs[*].name

MaterialAttributeToFPAs[*].name

MaterialAttributeToIPAs[*].name

MaterialAttributeToIQAs[*].name

The user interface groups risk links together; however, the API response returns them as separate arrays according to their model.

riskInfo.Criticality.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.criticality.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.Criticality.riskLabel

-

riskInfo.Criticality.scoreLabel

-

recommendedActions

-

scaleDependent

-

scaleJustification

-

riskLinks OR

MaterialAttributeToFQAs[*].links

MaterialAttributeToFPAs[*].links

MaterialAttributeToIPAs[*].links

MaterialAttributeToIQAs[*].links

Response is an array of encoded JSON objects in the format of Source Documents.

The riskLinks object is used when the AppliesTo field isn’t associated with relationships (e.g., Attribute to IQA).

If AppliesTo references a relationship, the response object will be included in the relationship array's links object.

When one link is associated (via AppliesTo) with different model types, then the link is returned in both objects.

dataSpace

-

measure

-

measurementUnits

-

lowerLimit

Objects at the base come from the Primary Reporting Criteria.

target

Objects at the base come from the Primary Reporting Criteria.

upperLimit

Objects at the base come from the Primary Reporting Criteria.

ControlMethods[*].name

Response is an array of objects containing summary Control Method details.

samplingPlan

-

targetJustification

-

acceptanceCriteriaLinks

An array of encoded JSON objects in the format of Source Documents.

capabilityRisk OR

riskInfo.”Capability Risk”.riskScore
riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The capabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskinfo.”Process Risk”.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

estimatedSampleSize

-

capabilityJustification

-

detectabilityRisk ||

riskInfo.”Detectability Risk”.value

riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The detectabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskInfo.RPN.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

-

riskInfo.RPN.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

controlStrategy

An array of Strings.

CCP

-

controlStrategyJustification

-

riskControlLinks

An array of encoded JSON objects in the format of Source Documents.

referencesLinks

An array of encoded JSON objects in the format of Source Documents.

ProcessParameterVersions[<version ID>].majorVersion + “.” + ProcessParameterVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

Use LastVersionId or LastApprovedVersionId to access the array.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (IQA) and the ID.

name

-

DrugProductId or DrugSubstanceId

An Attribute can only belong to one. ID is returned; the name must be looked up.

UnitOperation.name

Other fields exist, including UnitOperationId and the parents array.

StepId

Other fields exist, including UnitOperationId and the parents array.

type

-

description

-

IQAToFQAs[*].name

IQAToFPAs[*].name

IQAToIPAs[*].name

IQAToIQAs[*].name

The user interface groups risk links together; however, the API response returns them as separate arrays according to their model.

riskInfo.Criticality.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.criticality.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.Criticality.riskLabel

-

riskInfo.Criticality.scoreLabel

-

recommendedActions

-

scaleDependent

-

scaleJustification

-

riskLinks OR

IQAToFQAs[*].links

IQAToFPAs[*].links

IQAToIPAs[*].links

IQAToIQAs[*].links

Response is an array of encoded JSON objects in the format of Source Documents.

The riskLinks object is used when the AppliesTo field isn’t associated with relationships (e.g., Attribute to IQA).

If AppliesTo references a relationship, the response object will be included in the relationship array's links object.

When one link is associated (via AppliesTo) with different model types, then the link is returned in both objects.

dataSpace

-

measure

-

measurementUnits

-

lowerLimit

Objects at the base come from the Primary Reporting Criteria.

target

Objects at the base come from the Primary Reporting Criteria.

upperLimit

Objects at the base come from the Primary Reporting Criteria.

ControlMethods[*].name

Response is an array of objects containing summary Control Method details.

samplingPlan

-

targetJustification

-

acceptanceCriteriaLinks

An array of encoded JSON objects in the format of Source Documents.

capabilityRisk OR

riskInfo.”Capability Risk”.riskScore
riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The capabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskinfo.”Process Risk”.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

estimatedSampleSize

-

capabilityJustification

-

detectabilityRisk OR

riskInfo.”Detectability Risk”.value

riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The detectabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskInfo.RPN.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

-

riskInfo.RPN.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

controlStrategy

An array of Strings.

CCP

-

controlStrategyJustification

-

riskControlLinks

An array of encoded JSON objects in the format of Source Documents.

referencesLinks

An array of encoded JSON objects in the format of Source Documents.

IQAVersions[<version ID>].majorVersion + “.” + IQAVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (IPA) and the ID.

name

-

DrugProductId or DrugSubstanceId

An Attribute can only belong to one. ID is returned; the name must be looked up.

UnitOperation.name

Other fields exist, including UnitOperationId and the parents array.

StepId

Other fields exist, including UnitOperationId and the parents array.

type

-

description

-

IPAToFQAs[*].name

IPAToFPAs[*].name

IPAToIPAs[*].name

IPAToIQAs[*].name

The user interface groups risk links together; however, the API response returns them as separate arrays according to their model.

riskInfo.Criticality.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.criticality.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.Criticality.riskLabel

-

riskInfo.Criticality.scoreLabel

-

recommendedActions

-

scaleDependent

-

scaleJustification

-

riskLinks OR

IPAToFQAs[*].links

IPAToFPAs[*].links

IPAToIPAs[*].links

IPAToIQAs[*].links

Response is an array of encoded JSON objects in the format of Source Documents.

The riskLinks object is used when the AppliesTo field isn’t associated with relationships (e.g., Attribute to IQA).

If AppliesTo references a relationship, the response object will be included in the relationship array's links object.

When one link is associated (via AppliesTo) with different model types, then the link is returned in both objects.

dataSpace

-

measure

-

measurementUnits

-

lowerLimit

Objects at the base come from the Primary Reporting Criteria.

target

Objects at the base come from the Primary Reporting Criteria.

upperLimit

Objects at the base come from the Primary Reporting Criteria.

ControlMethods[*].name

Response is an array of objects containing summary Control Method details.

samplingPlan

-

targetJustification

-

acceptanceCriteriaLinks

An array of encoded JSON objects in the format of Source Documents.

capabilityRisk OR

riskInfo.”Capability Risk”.riskScore
riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The capabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskinfo.”Process Risk”.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.”Process Risk”.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

estimatedSampleSize

-

capabilityJustification

-

detectabilityRisk ||

riskInfo.”Detectability Risk”.value

riskInfo.”Capability Risk”.scoreLabel

In the UI, capability risk is contacted with the value and the label.

The detectabilityRisk attribute returns the raw value and sits at the root of the response object.

riskInfo is the preferred method for accessing.

riskInfo.RPN.value

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

In Dynamics Tables, this field is combined with the Risk Label.

riskInfo.RPN.normalizedValue

-

riskInfo.RPN.riskLabel

This field is not shown in the Record UI. It is visible in Dynamic Tables and other reporting interfaces.

controlStrategy

An array of Strings.

CCP

-

controlStrategyJustification

-

riskControlLinks

An array of encoded JSON objects in the format of Source Documents.

referencesLinks

An array of encoded JSON objects in the format of Source Documents.

IPAVersions[<version ID>].majorVersion + “.” + IPAVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

Use LastVersionId or LastApprovedVersionId to access the array.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (CM) and the ID.

name

-

type

-

category

-

compendialStandard

-

description

-

equipment

-

controlMethodLinks

An array of encoded JSON objects in the format of Source Documents.

SupplierId

Supplier.name

Supplier object included in the response.

status

stabilityIndicating

developmentLinks

An array of encoded JSON objects in the format of Source Documents.

referencesLinks

An array of encoded JSON objects in the format of Source Documents.

ControlMethodVersions[<version ID>].majorVersion + “.” + ControlMethodVersions[<version ID>].minorVersion

Requires the usage of the includeHistory query parameter.

Use LastVersionId or LastApprovedVersionId to access the array.

typeCode + “ -” + id

The ID field in the UI is a concatenation of the TypeCode (DOC) and the ID.

name

-

customID

-

project.name

JSON Object

type

-

controlled

-

category

-

effectiveDate

-

site

-

purpose

-

scope

-

author

-

sme

-

uploadDocumentLinks

JSON Object of Source Documents

If isQbdSrcDoc=true

documentContent

Else: originalDocumentLinks

The documentContent object is the representation of a QbDVision document (Doc Builder).

regulatoryDocument

-

ectdSection

-

dhfSection

-

dmrSection

-

k510Section

-

pmaSection

-

referencesLinks

JSON Object of Source Documents

customID

The ID referenced in the user interface comes from the customID field. However, these objects also maintain a QbDVision ID, which is used to query and comes back in the response object as id.

batchType

Array of possible types

ProcessId

ID is returned; the name must be looked up.

SupplierId

ID is returned; the name must be looked up.

startDate

-

manufactureDate

-

releaseDate

-

expirationDate

-

site

-

scale

-

purpose

-

attributes

List of Attribute objects.

/editables/${model}/list/${projectId}

Returns basic information for records filtered by model and projectId.

Basic fields:

• id

• name

• currentState

• modelName

• majorVersion

• minorVersion

Version retrieved:

• Latest approved version

• Draft if there was not a previously approved version

model:

• FQA

• FPA

• ProcessParameter

• MaterialAttribute

• UnitOperation

• Step

• IQA

• IPA

blank

Returns Approved if exists, but otherwise draft

Includes field named LastVersionthat contains information about the last version of the record.

onlyApproved=true

Returns only objects that are approved and don’t have a new draft

showRemoved=true

Includes also the archived records

includeAllVersions=true

includes a field (array) named allVersionsWithDetails. This field contains all the versions, and each version includes all the fields.

includeAllApprovedVersions=true

includes a field (array) named approvedVersionsWithDetails. This field contains the approved versions and each version includes all the fields.

sortBy=field,direction

field = any field from the record (name, description)

direction = asc or desc

/editables/${model}/${recordId}

Return full information about a record.

Version retrieved:

• Latest approved version

• Draft if there was not a previously approved version

blank

Returns Approved if exists, but otherwise draft

approved=false

Returns last version from the record (regardless if it is approved or draft)

approved =true

Returns last approved version

includeHistory=true

Includes a field (Array) ${model}Versions with all the versions of the record

/editables/multiple/list/${projectId}

Get multiple records by recordId and projectId

Request method: PUT

Sample Request Payload:
{"requirementIds":["PR-2","UO-1","UO-2","UO-3","PP-1","PP-2","PP-3"]}

Response is always compressed

Returns the latest version of the record (regardless if it was approved or not)

blank

Returns the latest version of the record (regardless if it was approved or not)

returnLatestApprovedOrDraftVersionsOnly=true

Version retrieved:

• Latest approved version

• Draft if there is not a previously approved version

includeHistory=true

Includes all the versions for the retrieved record

/processExplorer/${projectId}

Get all process records for a projectId

Only basic information for record is retrieved (id, name, currentState)

Version retrieved:

• Latest approved version

• Draft if there was not a previously approved version

blank

Returns compressed result

shouldCompress=false

Returns uncompressed result

approvedOnly=true

Return the latest approved version of records. Records without any approved version will not be returned.

processId=${processId}

Returns records from the specified process

outputStructure=tree|map

Result format in Tree or Map format. Default: map

outputFormat=XML|JSON

For XML data you need to use outputStructure=tree and standard=ISA-95

Default: json