API

Quality management APIs

GET system/reports/107346/result-set?type={type}&category={category}&fromDate={fromDate}&toDate={toDate}

Report for quality issues for easy filtering and scheduled export possibilities.

Report name Quality issues report
Report identifier 107346
HTTP method GET
URI https://api.rambase.net/system/reports/107346/result-set?type={type}&category={category}&fromDate={fromDate}&toDate={toDate}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 4792, version 35

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

type String, optional Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"
category String, optional Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing
fromDate Date, optional Issues created from this date
toDate Date, optional Issues created to this date
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Active quality issues
AssignedToMe() Named filter Quality issues assigned to me
Closed() Named filter Closed quality issues
CreatedByMe() Named filter Quality issues created by me
InReview() Named filter Quality issues currently being reviewed
MeAsResponsible() Named filter Me as responsible
MyIssues() Named filter Issues assigned to me and I'm responsible for
Overdue() Named filter Overdue quality issues
PendingActions() Named filter Actions to fix or prevent quality issues are in progress
PendingAnalysing() Named filter Quality issues being analyzed
PendingRegistration() Named filter Pending registration, not all data collected
ReportedByCustomers() Named filter Quality issues reported by a customer
ReportedByEmployees() Named filter Quality issues reported by an employee
ReportedBySuppliers() Named filter Quality issues reported by a supplier
WithoutDirectCause() Named filter Issues without assigned any direct cause
WithoutRootCause() Named filter Issues without assigned any root cause
AssigneeEmployeeId Integer Identifier of the person who has beed assigned to work on this object.
Category Integer Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing.
ClosedAt Datetime Time and date when this issue was resolved. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ContainingConsequenceArea Integer Quality consequence identifier.
ContainingConsequenceType Integer Consequence type is a text that shortly describes the direct consequence of an incidient. I.E "broken arm".
ContainingDirectCauseCategory Integer All issues containg this direct cause in cause analysis.
ContainingExternalCorrespondenceResponseStatus Integer Filter for external correspondence response status.
ContainingExternalCorrespondenceStatus Integer Filter on external correspondence status.
ContainingExternalCorrespondenceSuggestedAction Integer Action on the response.
ContainingExternalCorrespondenceType Integer Filter for external correspondence type.
ContainingRootCauseCategory Integer All issues containing this root cause in cause analysis.
CreatedAt Datetime Date and time when quality issue was created. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedByUserId Integer Identifier of the person who created this object.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
DepartmentId Integer Department identifier.
DueDate Date Time and date when this issue should be resolved. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ExternalReference String External reference identifier from the customer.
IsMarkedForNCR Boolean Whether or not an issue is marked as non conformance report (NCR).
LocationId Integer Location identifier.
OccuredAt Datetime Time and date when the issue occured. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
QualityIssueId Integer Quality issue identifier.
RegisteredAt Datetime Time and date when this issue was registered. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ReportedByCustomerId Integer Customer identifier.
ReportedByEmployeeId Integer Identifier of the person who is reported of this object.
ReportedBySupplierId Integer RamBase supplier identifier.
RequireReview Boolean True if this issue requires a review. False if not.
ResponsibleEmployeeId Integer Identifier of the person who is responsible for this object.
RiskScore Integer A calculated score of how much of a risk this issue indicates. It is the product of likelihood and rating (severity).
SourceAffectedQuantity Integer Quantity of product units affected by this quality issue.
SourceCustomerId Integer Customer identifier related to the source of the quality issue.
SourceDetectedOnProductionOperationId Integer Identifier of the production operation where quality issue was detected.
SourceFinanceProjectId Integer Finance project identifier.
SourceItemId Integer Item-number of the object.
SourceManufacturerId Integer Manufacturer identifier.
SourceMaterialClassificationId String Material classification identifier.
SourceMaterialId Integer Material identifier.
SourceObjectId Integer Identifier of the object.
SourceObjectType String Type of object.
SourceOccurredOnProductionOperationId Integer Identifier of the production operation where quality issue occured.
SourceProductClassificationId String Product classification identifier.
SourceProductId Integer Product identifier.
SourceProductionResourceId Integer Production resource identifier.
SourceProductionWorkOrderId Integer Production work order identifier.
SourcePurchaseOrderId Integer Purchase order identifier.
SourcePurchaseOrderItemId Integer Purchase order item identifier.
SourceSalesOrderId Integer Sales order identifier.
SourceSalesOrderItemId Integer Sales order item identifier.
SourceSupplierId Integer Supplier identifier related to the source of quality issue.
SourceTotalQuantity Integer The quantity that will be (or has been) produced.
Status Integer Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed.
Title String Title of the issue.
TotalCost Decimal Total cost of the issue.
Type Integer Quality issue type. I.E "Incident", "Observation" or "Improvement proposal".

Read more about filters and sorting on how to use sortable parameters

AssigneeEmployeeId Integer Identifier of the person who has beed assigned to work on this object.
Category Integer Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing
ClosedAt Datetime Time and date when this issue was resolved
ContainingConsequenceArea Integer Quality consequence identifier
ContainingConsequenceType Integer Consequence type is a text that shortly describes the direct consequence of an incidient. I.E "broken arm".
ContainingDirectCauseCategory Integer All issues containg this direct cause in cause analysis.
ContainingExternalCorrespondenceResponseStatus Integer Filter for external correspondence response status
ContainingExternalCorrespondenceStatus Integer Filter on external correspondence status
ContainingExternalCorrespondenceSuggestedAction Integer Action on the response
ContainingExternalCorrespondenceType Integer Filter for external correspondence type
ContainingRootCauseCategory Integer All issues containing this root cause in cause analysis.
CreatedAt Datetime Date and time when quality issue was created
CreatedByUserId Integer Identifier of the person who created this object.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
DepartmentId Integer Department identifier
DueDate Date Time and date when this issue should be resolved
ExternalReference String External reference identifier from the customer
IsMarkedForNCR Boolean Whether or not an issue is marked as non conformance report (NCR)
LocationId Integer Location identifier
OccuredAt Datetime Time and date when the issue occured
QualityIssueId Integer Quality issue identifier
RegisteredAt Datetime Time and date when this issue was registered
ReportedByCustomerId Integer Customer identifier
ReportedByEmployeeId Integer Identifier of the person who is reported of this object.
ReportedBySupplierId Integer RamBase supplier identifier
RequireReview Boolean True if this issue requires a review. False if not
ResponsibleEmployeeId Integer Identifier of the person who is responsible for this object.
RiskScore Integer A calculated score of how much of a risk this issue indicates. It is the product of likelihood and rating (severity)
SourceAffectedQuantity Integer Quantity of product units affected by this quality issue.
SourceCustomerId Integer Customer identifier related to the source of the quality issue
SourceDetectedOnProductionOperationId Integer Identifier of the production operation where quality issue was detected
SourceFinanceProjectId Integer Finance project identifier
SourceItemId Integer Item-number of the object
SourceManufacturerId Integer Manufacturer identifier
SourceMaterialClassificationId String Material classification identifier
SourceMaterialId Integer Material identifier
SourceObjectId Integer Identifier of the object
SourceObjectType String Type of object
SourceOccurredOnProductionOperationId Integer Identifier of the production operation where quality issue occured
SourceProductClassificationId String Product classification identifier
SourceProductId Integer Product identifier
SourceProductionResourceId Integer Production resource identifier
SourceProductionWorkOrderId Integer Production work order identifier
SourcePurchaseOrderId Integer Purchase order identifier
SourcePurchaseOrderItemId Integer Purchase order item identifier
SourceSalesOrderId Integer Sales order identifier
SourceSalesOrderItemId Integer Sales order item identifier
SourceSupplierId Integer Supplier identifier related to the source of quality issue
SourceTotalQuantity Integer The quantity that will be (or has been) produced
Status Integer Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed
Title String Title of the issue
TotalCost Decimal Total cost of the issue
Type Integer Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Report>
2
     <Rows>
3
          <Row>
4
               <Status
Status

Status of the item/object.

Possible domain values can be found here

>
{Integer}</Status>
5
               <QualityIssueId
QualityIssueId

Quality issue identifier

>
{Integer}</QualityIssueId>
6
               <Title
Title

Title of the issue

>
{String}</Title>
7
               <CreatedBy
CreatedBy

Person who created this issue

>
8
                    <UserId
UserId

User identifier

>
{Integer}</UserId>
9
                    <FirstName
FirstName

First name of the user

>
{String}</FirstName>
10
                    <Name
Name

Name of the user

>
{String}</Name>
11
                    <UserLink
UserLink

User reference

>
{String}</UserLink>
12
               </CreatedBy>
13
               <CreatedAt
CreatedAt

Date and time of creation

>
{Date}</CreatedAt>
14
               <OccuredAt
OccuredAt

Time and date when the issue occured

>
{Datetime}</OccuredAt>
15
               <Description
Description

Description of quality issue

>
{String}</Description>
16
               <Type
Type

Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"

>
{String}</Type>
17
               <Category
Category

Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing

>
{String}</Category>
18
               <DueDate
DueDate

Time and date when this issue should be resolved

>
{Date}</DueDate>
19
               <RiskScore
RiskScore

A calculated score of how much of a risk this issue indicates. It is the product of likelihood and rating (severity)

>
{Integer}</RiskScore>
20
               <IsMarkedForNCR
IsMarkedForNCR

Whether or not an issue is marked as non conformance report (NCR)

>
{Boolean}</IsMarkedForNCR>
21
               <RegisteredAt
RegisteredAt

Time and date when this issue was registered

>
{Date}</RegisteredAt>
22
               <ClosedAt
ClosedAt

Time and date when this issue was resolved

>
{Date}</ClosedAt>
23
               <ExternalReference
ExternalReference

External reference identifier from the customer

>
{String}</ExternalReference>
24
               <ReportedBy
ReportedBy

Employee, customer or supplier who reported quality issue.

>
25
                    <Name
Name

Name of the issue reporter

>
{String}</Name>
26
                    <Object
Object

Object reference

>
27
                         <ObjectType
ObjectType

Type of object

>
{String}</ObjectType>
28
                         <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
29
                         <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
30
                         <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
31
                    </Object>
32
               </ReportedBy>
33
               <Location
Location

Location where issue occurred.

>
34
                    <LocationId
LocationId

Location identifier

>
{Integer}</LocationId>
35
                    <ShortName
ShortName

Unique abbreviation/short name of the location

>
{String}</ShortName>
36
                    <LocationLink
LocationLink

Location reference

>
{String}</LocationLink>
37
               </Location>
38
               <Responsible
Responsible

The user who has been assigned to be responsible for this object.

>
39
                    <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
40
                    <LastName
LastName

Last name of employee

>
{String}</LastName>
41
                    <FirstName
FirstName

First name of employee

>
{String}</FirstName>
42
                    <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
43
               </Responsible>
44
               <Assignee
Assignee

The user who has been assigned to work with this object.

>
45
                    <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
46
                    <LastName
LastName

Last name of employee

>
{String}</LastName>
47
                    <FirstName
FirstName

First name of employee

>
{String}</FirstName>
48
                    <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
49
               </Assignee>
50
               <Department
Department

Department responsible to work on this issue

>
51
                    <DepartmentId
DepartmentId

Department identifier

>
{Integer}</DepartmentId>
52
                    <Name
Name

Name of department

>
{String}</Name>
53
                    <DepartmentLink
DepartmentLink

Finance department reference

>
{String}</DepartmentLink>
54
               </Department>
55
               <Source
Source

Document reference of source archive

>
56
                    <ItemId
ItemId

Reference to the item id of the object

>
{Integer}</ItemId>
57
                    <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
58
                    <ObjectType
ObjectType

Type of object

>
{String}</ObjectType>
59
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
60
                    <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
61
                    <ItemLink
ItemLink

API reference to the item

>
{String}</ItemLink>
62
               </Source>
63
               <AffectedQuantity
AffectedQuantity

Quantity of product units affected by this quality issue.

>
{Integer}</AffectedQuantity>
64
               <TotalQuantity
TotalQuantity

The quantity that will be (or has been) produced

>
{Integer}</TotalQuantity>
65
               <FinanceProject
FinanceProject

Finance project related to the source of this quality issue.

>
66
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

>
{Integer}</FinanceProjectId>
67
                    <Name
Name

Name of finance project

>
{String}</Name>
68
                    <FinanceProjectLink
FinanceProjectLink

Finance project reference

>
{String}</FinanceProjectLink>
69
               </FinanceProject>
70
               <Product
Product

Product reference

>
71
                    <ProductId
ProductId

Product identifier

>
{Integer}</ProductId>
72
                    <Name
Name

Name of the product

>
{String}</Name>
73
                    <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
74
               </Product>
75
               <ProductClassification
ProductClassification

Product classification reference

>
76
                    <ProductClassificationId
ProductClassificationId

Product classification identifier

>
{String}</ProductClassificationId>
77
                    <ProductClassificationLink
ProductClassificationLink

Product classification reference

>
{String}</ProductClassificationLink>
78
               </ProductClassification>
79
               <Drawing
Drawing

Drawing of the product structure

>
80
                    <FileId
FileId

File identifier

>
{String}</FileId>
81
                    <FileName
FileName

Filename to display for the file version. Will be used when downloading the file.

>
{String}</FileName>
82
                    <FileLink
FileLink

File reference

>
{String}</FileLink>
83
               </Drawing>
84
               <SourceCustomer
SourceCustomer

Reference to the customer related to this quality issue.

>
85
                    <CustomerId
CustomerId

Customer identifier

>
{Integer}</CustomerId>
86
                    <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>
{String}</Name>
87
                    <CustomerLink
CustomerLink

Customer reference

>
{String}</CustomerLink>
88
               </SourceCustomer>
89
               <SourceSupplier
SourceSupplier

Reference to the supplier related to this quality issue.

>
90
                    <SupplierId
SupplierId

RamBase supplier identifier

>
{Integer}</SupplierId>
91
                    <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>
{String}</Name>
92
                    <SupplierLink
SupplierLink

Supplier general ledger account is the default account that should be used on incoming invoices for this supplier.

>
{String}</SupplierLink>
93
               </SourceSupplier>
94
               <ProductionResource
ProductionResource

Production resource reference

>
95
                    <ProductionResourceId
ProductionResourceId

Production resource identifier

>
{Integer}</ProductionResourceId>
96
                    <Name
Name

Name of production resource

>
{String}</Name>
97
                    <ProductionResourceLink
ProductionResourceLink

Production resource reference

>
{String}</ProductionResourceLink>
98
               </ProductionResource>
99
               <SalesOrderItem
SalesOrderItem

Sales order item reference

>
100
                    <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>
{Integer}</SalesOrderItemId>
101
                    <SalesOrder
SalesOrder

Sales order reference

>
102
                         <SalesOrderId
SalesOrderId

Sales order identifier

>
{Integer}</SalesOrderId>
103
                         <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.SalesOrderItem.SalesOrder.CustomersReferenceNumber in your request URI to get this field

>
{String}</CustomersReferenceNumber>
104
                         <SalesOrderLink
SalesOrderLink

Sales order reference

>
{String}</SalesOrderLink>
105
                    </SalesOrder>
106
                    <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>
{String}</SalesOrderItemLink>
107
               </SalesOrderItem>
108
               <PurchaseOrderItem
PurchaseOrderItem

Purchase order item reference

>
109
                    <PurchaseOrderItemId
PurchaseOrderItemId

Purchase order item identifier

>
{Integer}</PurchaseOrderItemId>
110
                    <PurchaseOrder
PurchaseOrder

Purchase order reference

>
111
                         <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

>
{Integer}</PurchaseOrderId>
112
                         <PurchaseOrderLink
PurchaseOrderLink

Purchase order reference

>
{String}</PurchaseOrderLink>
113
                    </PurchaseOrder>
114
                    <PurchaseOrderItemLink
PurchaseOrderItemLink

Reference to the purchase order item

>
{String}</PurchaseOrderItemLink>
115
               </PurchaseOrderItem>
116
               <Manufacturer
Manufacturer

Manufacturer reference

>
117
                    <ManufacturerId
ManufacturerId

Manufacturer identifier

>
{Integer}</ManufacturerId>
118
                    <Name
Name

Company name of the manufacturer.

>
{String}</Name>
119
                    <ManufacturerLink
ManufacturerLink

Manufacturer reference

>
{String}</ManufacturerLink>
120
               </Manufacturer>
121
               <DetectedOnOperation
DetectedOnOperation

Production operation reference where quality issue was detected.

>
122
                    <ProductionOperationId
ProductionOperationId

Production operation identifier

>
{Integer}</ProductionOperationId>
123
                    <Name
Name

Name of production operation

>
{String}</Name>
124
                    <ProductionOperationLink
ProductionOperationLink

Production operation reference

>
{String}</ProductionOperationLink>
125
               </DetectedOnOperation>
126
               <OccurredOnOperation
OccurredOnOperation

Production operation where quality issue occured on

>
127
                    <ProductionOperationId
ProductionOperationId

Production operation identifier

>
{Integer}</ProductionOperationId>
128
                    <Name
Name

Name of production operation

>
{String}</Name>
129
                    <ProductionOperationLink
ProductionOperationLink

Production operation reference

>
{String}</ProductionOperationLink>
130
               </OccurredOnOperation>
131
               <Material
Material

Material reference

>
132
                    <ProductId
ProductId

Product identifier

>
{Integer}</ProductId>
133
                    <Name
Name

Name of the product

>
{String}</Name>
134
                    <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
135
               </Material>
136
               <MaterialClassification
MaterialClassification

Material classification reference

>
137
                    <ProductClassificationId
ProductClassificationId

Product classification identifier

>
{String}</ProductClassificationId>
138
                    <ProductClassificationLink
ProductClassificationLink

Product classification reference

>
{String}</ProductClassificationLink>
139
               </MaterialClassification>
140
               <ProductionWorkOrder
ProductionWorkOrder

Production work order reference

>
141
                    <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>
{Integer}</ProductionWorkOrderId>
142
                    <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>
{String}</ProductionWorkOrderLink>
143
               </ProductionWorkOrder>
144
               <TotalCost
TotalCost

Total cost / {SYSCUR}

>
{Decimal}</TotalCost>
145
               <Inspect>
146
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>
{String}</TargetApplication>
147
               </Inspect>
148
          </Row>
149
     </Rows>
150
     <ColumnParameters
ColumnParameters

This field is greyed out because it is an expandable field. You have to add $expand=ColumnParameters in your request URI to get this field

>
151
          <ColumnParameter
ColumnParameter

This field is greyed out because it is an expandable field. You have to add $expand=ColumnParameters in your request URI to get this field

>
152
               <Key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

This field is greyed out because it is an expandable field. You have to add $expand=ColumnParameters in your request URI to get this field

>
{String}</Key>
153
               <Value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

This field is greyed out because it is an expandable field. You have to add $expand=ColumnParameters in your request URI to get this field

>
{String}</Value>
154
          </ColumnParameter>
155
     </ColumnParameters>
156
     <Paging
Paging

Detailed paging information for this list.

>
157
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>
{Integer}</PageSize>
158
          <Position
Position

Position of the first element in the list

>
{Integer}</Position>
159
          <Page
Page

Page index

>
{Integer}</Page>
160
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</FirstPageKey>
161
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>
{String}</FirstPage>
162
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</PreviousPageKey>
163
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>
{String}</PreviousPage>
164
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</NextPageKey>
165
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>
{String}</NextPage>
166
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</LastPageKey>
167
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>
{String}</LastPage>
168
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>
{Integer}</Size>
169
     </Paging>
170
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "status
Status

Status of the item/object.

Possible domain values can be found here

":
"{Integer}",
6
                    "qualityIssueId
QualityIssueId

Quality issue identifier

":
"{Integer}",
7
                    "title
Title

Title of the issue

":
"{String}",
8
                    "createdBy
CreatedBy

Person who created this issue

":
{
9
                         "userId
UserId

User identifier

":
"{Integer}",
10
                         "firstName
FirstName

First name of the user

":
"{String}",
11
                         "name
Name

Name of the user

":
"{String}",
12
                         "userLink
UserLink

User reference

":
"{String}"
13
                    },
14
                    "createdAt
CreatedAt

Date and time of creation

":
"{Date}",
15
                    "occuredAt
OccuredAt

Time and date when the issue occured

":
"{Datetime}",
16
                    "description
Description

Description of quality issue

":
"{String}",
17
                    "type
Type

Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"

":
"{String}",
18
                    "category
Category

Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing

":
"{String}",
19
                    "dueDate
DueDate

Time and date when this issue should be resolved

":
"{Date}",
20
                    "riskScore
RiskScore

A calculated score of how much of a risk this issue indicates. It is the product of likelihood and rating (severity)

":
"{Integer}",
21
                    "isMarkedForNCR
IsMarkedForNCR

Whether or not an issue is marked as non conformance report (NCR)

":
"{Boolean}",
22
                    "registeredAt
RegisteredAt

Time and date when this issue was registered

":
"{Date}",
23
                    "closedAt
ClosedAt

Time and date when this issue was resolved

":
"{Date}",
24
                    "externalReference
ExternalReference

External reference identifier from the customer

":
"{String}",
25
                    "reportedBy
ReportedBy

Employee, customer or supplier who reported quality issue.

":
{
26
                         "name
Name

Name of the issue reporter

":
"{String}",
27
                         "object
Object

Object reference

":
{
28
                              "objectType
ObjectType

Type of object

":
"{String}",
29
                              "objectId
ObjectId

Identifier of the object

":
"{Integer}",
30
                              "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

":
"{String}",
31
                              "objectLink
ObjectLink

API reference to the object

":
"{String}"
32
                         }
33
                    },
34
                    "location
Location

Location where issue occurred.

":
{
35
                         "locationId
LocationId

Location identifier

":
"{Integer}",
36
                         "shortName
ShortName

Unique abbreviation/short name of the location

":
"{String}",
37
                         "locationLink
LocationLink

Location reference

":
"{String}"
38
                    },
39
                    "responsible
Responsible

The user who has been assigned to be responsible for this object.

":
{
40
                         "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
41
                         "lastName
LastName

Last name of employee

":
"{String}",
42
                         "firstName
FirstName

First name of employee

":
"{String}",
43
                         "employeeLink
EmployeeLink

Employee reference

":
"{String}"
44
                    },
45
                    "assignee
Assignee

The user who has been assigned to work with this object.

":
{
46
                         "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
47
                         "lastName
LastName

Last name of employee

":
"{String}",
48
                         "firstName
FirstName

First name of employee

":
"{String}",
49
                         "employeeLink
EmployeeLink

Employee reference

":
"{String}"
50
                    },
51
                    "department
Department

Department responsible to work on this issue

":
{
52
                         "departmentId
DepartmentId

Department identifier

":
"{Integer}",
53
                         "name
Name

Name of department

":
"{String}",
54
                         "departmentLink
DepartmentLink

Finance department reference

":
"{String}"
55
                    },
56
                    "source
Source

Document reference of source archive

":
{
57
                         "itemId
ItemId

Reference to the item id of the object

":
"{Integer}",
58
                         "objectId
ObjectId

Identifier of the object

":
"{Integer}",
59
                         "objectType
ObjectType

Type of object

":
"{String}",
60
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

":
"{String}",
61
                         "objectLink
ObjectLink

API reference to the object

":
"{String}",
62
                         "itemLink
ItemLink

API reference to the item

":
"{String}"
63
                    },
64
                    "affectedQuantity
AffectedQuantity

Quantity of product units affected by this quality issue.

":
"{Integer}",
65
                    "totalQuantity
TotalQuantity

The quantity that will be (or has been) produced

":
"{Integer}",
66
                    "financeProject
FinanceProject

Finance project related to the source of this quality issue.

":
{
67
                         "financeProjectId
FinanceProjectId

Finance project identifier

":
"{Integer}",
68
                         "name
Name

Name of finance project

":
"{String}",
69
                         "financeProjectLink
FinanceProjectLink

Finance project reference

":
"{String}"
70
                    },
71
                    "product
Product

Product reference

":
{
72
                         "productId
ProductId

Product identifier

":
"{Integer}",
73
                         "name
Name

Name of the product

":
"{String}",
74
                         "productLink
ProductLink

Product reference

":
"{String}"
75
                    },
76
                    "productClassification
ProductClassification

Product classification reference

":
{
77
                         "productClassificationId
ProductClassificationId

Product classification identifier

":
"{String}",
78
                         "productClassificationLink
ProductClassificationLink

Product classification reference

":
"{String}"
79
                    },
80
                    "drawing
Drawing

Drawing of the product structure

":
{
81
                         "fileId
FileId

File identifier

":
"{String}",
82
                         "fileName
FileName

Filename to display for the file version. Will be used when downloading the file.

":
"{String}",
83
                         "fileLink
FileLink

File reference

":
"{String}"
84
                    },
85
                    "sourceCustomer
SourceCustomer

Reference to the customer related to this quality issue.

":
{
86
                         "customerId
CustomerId

Customer identifier

":
"{Integer}",
87
                         "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

":
"{String}",
88
                         "customerLink
CustomerLink

Customer reference

":
"{String}"
89
                    },
90
                    "sourceSupplier
SourceSupplier

Reference to the supplier related to this quality issue.

":
{
91
                         "supplierId
SupplierId

RamBase supplier identifier

":
"{Integer}",
92
                         "name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

":
"{String}",
93
                         "supplierLink
SupplierLink

Supplier general ledger account is the default account that should be used on incoming invoices for this supplier.

":
"{String}"
94
                    },
95
                    "productionResource
ProductionResource

Production resource reference

":
{
96
                         "productionResourceId
ProductionResourceId

Production resource identifier

":
"{Integer}",
97
                         "name
Name

Name of production resource

":
"{String}",
98
                         "productionResourceLink
ProductionResourceLink

Production resource reference

":
"{String}"
99
                    },
100
                    "salesOrderItem
SalesOrderItem

Sales order item reference

":
{
101
                         "salesOrderItemId
SalesOrderItemId

Sales order item identifier

":
"{Integer}",
102
                         "salesOrder
SalesOrder

Sales order reference

":
{
103
                              "salesOrderId
SalesOrderId

Sales order identifier

":
"{Integer}",
104
                              "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.SalesOrderItem.SalesOrder.CustomersReferenceNumber in your request URI to get this field

":
"{String}",
105
                              "salesOrderLink
SalesOrderLink

Sales order reference

":
"{String}"
106
                         },
107
                         "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

":
"{String}"
108
                    },
109
                    "purchaseOrderItem
PurchaseOrderItem

Purchase order item reference

":
{
110
                         "purchaseOrderItemId
PurchaseOrderItemId

Purchase order item identifier

":
"{Integer}",
111
                         "purchaseOrder
PurchaseOrder

Purchase order reference

":
{
112
                              "purchaseOrderId
PurchaseOrderId

Purchase order identifier

":
"{Integer}",
113
                              "purchaseOrderLink
PurchaseOrderLink

Purchase order reference

":
"{String}"
114
                         },
115
                         "purchaseOrderItemLink
PurchaseOrderItemLink

Reference to the purchase order item

":
"{String}"
116
                    },
117
                    "manufacturer
Manufacturer

Manufacturer reference

":
{
118
                         "manufacturerId
ManufacturerId

Manufacturer identifier

":
"{Integer}",
119
                         "name
Name

Company name of the manufacturer.

":
"{String}",
120
                         "manufacturerLink
ManufacturerLink

Manufacturer reference

":
"{String}"
121
                    },
122
                    "detectedOnOperation
DetectedOnOperation

Production operation reference where quality issue was detected.

":
{
123
                         "productionOperationId
ProductionOperationId

Production operation identifier

":
"{Integer}",
124
                         "name
Name

Name of production operation

":
"{String}",
125
                         "productionOperationLink
ProductionOperationLink

Production operation reference

":
"{String}"
126
                    },
127
                    "occurredOnOperation
OccurredOnOperation

Production operation where quality issue occured on

":
{
128
                         "productionOperationId
ProductionOperationId

Production operation identifier

":
"{Integer}",
129
                         "name
Name

Name of production operation

":
"{String}",
130
                         "productionOperationLink
ProductionOperationLink

Production operation reference

":
"{String}"
131
                    },
132
                    "material
Material

Material reference

":
{
133
                         "productId
ProductId

Product identifier

":
"{Integer}",
134
                         "name
Name

Name of the product

":
"{String}",
135
                         "productLink
ProductLink

Product reference

":
"{String}"
136
                    },
137
                    "materialClassification
MaterialClassification

Material classification reference

":
{
138
                         "productClassificationId
ProductClassificationId

Product classification identifier

":
"{String}",
139
                         "productClassificationLink
ProductClassificationLink

Product classification reference

":
"{String}"
140
                    },
141
                    "productionWorkOrder
ProductionWorkOrder

Production work order reference

":
{
142
                         "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

":
"{Integer}",
143
                         "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

":
"{String}"
144
                    },
145
                    "totalCost
TotalCost

Total cost / {SYSCUR}

":
"{Decimal}",
146
                    "inspect": {
147
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

":
"{String}"
148
                    }
149
               }
150
          ],
151
          "columnParameters
ColumnParameters

This field is greyed out because it is an expandable field. You have to add $expand=ColumnParameters in your request URI to get this field

":
[
152
               {
153
                    "key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

This field is greyed out because it is an expandable field. You have to add $expand=ColumnParameters in your request URI to get this field

":
"{String}",
154
                    "value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

This field is greyed out because it is an expandable field. You have to add $expand=ColumnParameters in your request URI to get this field

":
"{String}"
155
               }
156
          ]
157
     }
158
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type