API

Quality management APIs

POST quality/issues

Create a quality issue

HTTP method POST
URI https://api.rambase.net/quality/issues
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 4462, version 16

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
<QualityIssue>
2
     <Description
Description

Description of quality issue

This field is optional.

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

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

Applicable domain values can be found here

This field is optional.

>
{Integer}</Type>
4
     <Title
Title

Required/mandatory field

Title of the issue

>
{String}</Title>
5
     <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

Applicable domain values can be found here

This field is optional.

>
{Integer}</Category>
6
     <OccuredAt
OccuredAt

Time and date when the issue occured

This field is optional.

>
{Datetime}</OccuredAt>
7
     <DueDate
DueDate

Time and date when this issue should be resolved

This field is optional.

>
{Date}</DueDate>
8
     <RequireReview
RequireReview

True if this issue requires a review. False if not

Default value: False

This field is optional.

>
{Boolean}</RequireReview>
9
     <NotifyWhenClosed
NotifyWhenClosed

If true, a notification will be sent to the creator when closing this issue.

Default value: False

This field is optional.

>
{Boolean}</NotifyWhenClosed>
10
     <CreateAnonymously
CreateAnonymously

True, when issue should be created anonymously, otherwise False.

Default value: False

This field is optional.

>
{Boolean}</CreateAnonymously>
11
     <ExternalReference
ExternalReference

External reference identifier from the customer

This field is optional.

>
{String}</ExternalReference>
12
     <ExternalTitle
ExternalTitle

External title used in external correspondence. Is used in order to send modified title of quality issue to customer

This field is optional.

>
{String}</ExternalTitle>
13
     <Folder
Folder

This field is optional.

>
14
          <FolderId
FolderId

File folder id for a spesific file container or forlder.

Minimum value: 100000

This field is optional.

>
{Integer}</FolderId>
15
     </Folder>
16
     <ReportedBy
ReportedBy

This field is optional.

>
17
          <Object
Object

This field is optional.

>
18
               <ObjectType
ObjectType

Type of object

This field is optional.

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

Identifier of the object

Minimum value: 1

This field is optional.

>
{Integer}</ObjectId>
20
          </Object>
21
     </ReportedBy>
22
     <Location
Location

This field is optional.

>
23
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>
{Integer}</LocationId>
24
     </Location>
25
     <Responsible
Responsible

This field is optional.

>
26
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>
{Integer}</EmployeeId>
27
     </Responsible>
28
     <Assignee
Assignee

This field is optional.

>
29
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>
{Integer}</EmployeeId>
30
     </Assignee>
31
     <Department
Department

This field is optional.

>
32
          <DepartmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

>
{Integer}</DepartmentId>
33
     </Department>
34
     <Context
Context

This field is optional.

>
35
          <Source
Source

This field is optional.

>
36
               <ObjectId
ObjectId

Identifier of the object

This field is optional.

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

Type of object

This field is optional.

>
{String}</ObjectType>
38
               <ItemId
ItemId

Item-number of the object

This field is optional.

>
{Integer}</ItemId>
39
          </Source>
40
     </Context>
41
</QualityIssue>
1
{
2
     "qualityIssue": {
3
          "description
Description

Description of quality issue

This field is optional.

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

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

Applicable domain values can be found here

This field is optional.

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

Required/mandatory field

Title of the issue

":
"{String}",
6
          "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

Applicable domain values can be found here

This field is optional.

":
"{Integer}",
7
          "occuredAt
OccuredAt

Time and date when the issue occured

This field is optional.

":
"{Datetime}",
8
          "dueDate
DueDate

Time and date when this issue should be resolved

This field is optional.

":
"{Date}",
9
          "requireReview
RequireReview

True if this issue requires a review. False if not

Default value: False

This field is optional.

":
"{Boolean}",
10
          "notifyWhenClosed
NotifyWhenClosed

If true, a notification will be sent to the creator when closing this issue.

Default value: False

This field is optional.

":
"{Boolean}",
11
          "createAnonymously
CreateAnonymously

True, when issue should be created anonymously, otherwise False.

Default value: False

This field is optional.

":
"{Boolean}",
12
          "externalReference
ExternalReference

External reference identifier from the customer

This field is optional.

":
"{String}",
13
          "externalTitle
ExternalTitle

External title used in external correspondence. Is used in order to send modified title of quality issue to customer

This field is optional.

":
"{String}",
14
          "folder
Folder

This field is optional.

":
{
15
               "folderId
FolderId

File folder id for a spesific file container or forlder.

Minimum value: 100000

This field is optional.

":
"{Integer}"
16
          },
17
          "reportedBy
ReportedBy

This field is optional.

":
{
18
               "object
Object

This field is optional.

":
{
19
                    "objectType
ObjectType

Type of object

This field is optional.

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

Identifier of the object

Minimum value: 1

This field is optional.

":
"{Integer}"
21
               }
22
          },
23
          "location
Location

This field is optional.

":
{
24
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

":
"{Integer}"
25
          },
26
          "responsible
Responsible

This field is optional.

":
{
27
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
28
          },
29
          "assignee
Assignee

This field is optional.

":
{
30
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
31
          },
32
          "department
Department

This field is optional.

":
{
33
               "departmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

":
"{Integer}"
34
          },
35
          "context
Context

This field is optional.

":
{
36
               "source
Source

This field is optional.

":
{
37
                    "objectId
ObjectId

Identifier of the object

This field is optional.

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

Type of object

This field is optional.

":
"{String}",
39
                    "itemId
ItemId

Item-number of the object

This field is optional.

":
"{Integer}"
40
               }
41
          }
42
     }
43
}

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.

$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
$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.
$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]
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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

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

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

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

Format:
1
<QualityIssue>
2
     <QualityIssueId
QualityIssueId

Quality issue identifier

>
{Integer}</QualityIssueId>
3
     <CreatedAt
CreatedAt

Date and time when quality issue was created

>
{Datetime}</CreatedAt>
4
     <Status
Status

Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed

Possible domain values can be found here

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

Description of quality issue

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

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

Possible domain values can be found here

>
{Integer}</Type>
7
     <Title
Title

Title of the issue

>
{String}</Title>
8
     <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

Possible domain values can be found here

>
{Integer}</Category>
9
     <OccuredAt
OccuredAt

Time and date when the issue occured

>
{Datetime}</OccuredAt>
10
     <RegisteredAt
RegisteredAt

Time and date when this issue was registered

>
{Datetime}</RegisteredAt>
11
     <DueDate
DueDate

Time and date when this issue should be resolved

>
{Date}</DueDate>
12
     <ClosedAt
ClosedAt

Time and date when this issue was resolved

>
{Datetime}</ClosedAt>
13
     <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>
14
     <IsMarkedForNCR
IsMarkedForNCR

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

>
{Boolean}</IsMarkedForNCR>
15
     <NotifyWhenClosed
NotifyWhenClosed

If true, a notification will be sent to the creator when closing this issue.

>
{Boolean}</NotifyWhenClosed>
16
     <ExternalReference
ExternalReference

External reference identifier from the customer

>
{String}</ExternalReference>
17
     <ExternalTitle
ExternalTitle

External title used in external correspondence. Is used in order to send modified title of quality issue to customer

>
{String}</ExternalTitle>
18
     <RequireReview
RequireReview

True if this issue requires a review. False if not

>
{Boolean}</RequireReview>
19
     <CloseComment
CloseComment

Additional comment added by person who closes quality issue.

>
{String}</CloseComment>
20
     <ReviewComment
ReviewComment

Comment added by reviewer when they rejected review and typed some suggestions.

>
{String}</ReviewComment>
21
     <ReviewedAt
ReviewedAt

Date and time when quality issue was reviewed.

>
{Datetime}</ReviewedAt>
22
     <Folder>
23
          <FolderId
FolderId

File folder id for a spesific file container or forlder.

>
{Integer}</FolderId>
24
          <Name
Name

Verbose folder text in english.

>
{String}</Name>
25
          <FolderLink
FolderLink

Company folder id

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

Name of the issue reporter

>
{String}</Name>
27
          <Object>
28
               <ObjectType
ObjectType

Type of object

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

Identifier of the object

>
{Integer}</ObjectId>
30
               <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
31
          </Object>
32
          <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

>
{String}</LocationLink>
35
     </Folder>
36
     <Totals>
37
          <Currency
Currency

Three character code following the ISO 4217 standard

>
{String}</Currency>
38
          <TotalCost
TotalCost

Total cost of the issue

>
{Decimal}</TotalCost>
39
          <QualityIssueActionsCount
QualityIssueActionsCount

Count of all immediate and corrective actions.

>
{Integer}</QualityIssueActionsCount>
40
          <DoneQualityIssueActionsCount
DoneQualityIssueActionsCount

Count of done immediate and corrective actions.

>
{Integer}</DoneQualityIssueActionsCount>
41
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>
{String}</EmployeeLink>
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
          <UserId
UserId

User identifier

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

First name of the user

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

Name of the user

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

User reference

>
{String}</UserLink>
53
          <UserId
UserId

User identifier

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

First name of the user

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

Name of the user

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

User reference

>
{String}</UserLink>
57
          <DepartmentId
DepartmentId

Department identifier

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

Name of department

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

Finance department reference

>
{String}</DepartmentLink>
60
          <AffectedQuantity
AffectedQuantity

Quantity of product units affected by this quality issue.

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

The quantity that will be (or has been) produced

>
{Integer}</TotalQuantity>
62
          <Source>
63
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

>
{String}</ObjectType>
65
               <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
66
               <ItemId
ItemId

Item-number of the object

>
{Integer}</ItemId>
67
               <ItemLink
ItemLink

API reference to the item

>
{String}</ItemLink>
68
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
69
          </Source>
70
          <FinanceProject>
71
               <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

Finance project reference

>
{String}</FinanceProjectLink>
74
          </FinanceProject>
75
          <Product>
76
               <ProductId
ProductId

Product identifier

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

Name of the product

>
{String}</Name>
78
               <Description
Description

Description of the product

>
{String}</Description>
79
               <ProductClassification>
80
                    <ProductClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

>
{String}</ProductClassificationLink>
82
               </ProductClassification>
83
               <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
84
               <Revision
Revision

The Revision of the product

>
{String}</Revision>
85
               <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

>
{Integer}</ProductStructureVersionId>
86
               <Drawing
Drawing

Drawing of the product structure

>
87
                    <Database
Database

Database of the object

>
{String}</Database>
88
                    <FileVersionId
FileVersionId

File identifier

>
{String}</FileVersionId>
89
                    <FileName
FileName

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

>
{String}</FileName>
90
                    <FileVersionLink
FileVersionLink

File reference

>
{String}</FileVersionLink>
91
               </Drawing>
92
               <ProductStructure>
93
                    <ProductStructureId
ProductStructureId

Product structure identifier

>
{Long}</ProductStructureId>
94
               </ProductStructure>
95
               <ProductStructureVersionLink
ProductStructureVersionLink

Product structure reference

>
{String}</ProductStructureVersionLink>
96
          </Product>
97
          <Customer>
98
               <CustomerId
CustomerId

Customer identifier

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

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

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

Customer reference

>
{String}</CustomerLink>
101
          </Customer>
102
          <Supplier>
103
               <SupplierId
SupplierId

RamBase supplier identifier

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

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

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

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

>
{String}</SupplierLink>
106
          </Supplier>
107
          <ProductionResource>
108
               <ProductionResourceId
ProductionResourceId

Production resource identifier

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

Name of production resource

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

Production resource reference

>
{String}</ProductionResourceLink>
111
          </ProductionResource>
112
          <SalesOrder>
113
               <SalesOrderId
SalesOrderId

Sales order identifier

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

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

>
{String}</CustomersReferenceNumber>
115
               <Customer>
116
                    <CustomerId
CustomerId

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

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

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

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

Customer reference

>
{String}</CustomerLink>
119
               </Customer>
120
               <SalesOrderLink
SalesOrderLink

Sales order reference

>
{String}</SalesOrderLink>
121
          </SalesOrder>
122
          <SalesOrderItem>
123
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>
{Integer}</SalesOrderItemId>
124
               <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>
{String}</SalesOrderItemLink>
125
          </SalesOrderItem>
126
          <Manufacturer>
127
               <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

Manufacturer reference

>
{String}</ManufacturerLink>
130
          </Manufacturer>
131
          <DetectedOnOperation>
132
               <ProductionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Production operation reference

>
{String}</ProductionOperationLink>
135
          </DetectedOnOperation>
136
          <OccurredOnOperation>
137
               <ProductionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Production operation reference

>
{String}</ProductionOperationLink>
140
          </OccurredOnOperation>
141
          <Material>
142
               <ProductId
ProductId

Product identifier

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

Name of the product

>
{String}</Name>
144
               <Description
Description

Description of the product

>
{String}</Description>
145
               <ProductClassification>
146
                    <ProductClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

>
{String}</ProductClassificationLink>
148
               </ProductClassification>
149
               <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
150
          </Material>
151
          <ProductionWorkOrder>
152
               <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

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

Production work order reference

>
{String}</ProductionWorkOrderLink>
154
          </ProductionWorkOrder>
155
          <PurchaseOrder>
156
               <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

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

Purchase order reference

>
{String}</PurchaseOrderLink>
158
          </PurchaseOrder>
159
          <PurchaseOrderItem>
160
               <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

>
{Integer}</PurchaseOrderItemId>
161
               <PurchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

>
{String}</PurchaseOrderItemLink>
162
          </PurchaseOrderItem>
163
     </Totals>
164
</QualityIssue>
1
{
2
     "qualityIssue": {
3
          "qualityIssueId
QualityIssueId

Quality issue identifier

":
"{Integer}",
4
          "createdAt
CreatedAt

Date and time when quality issue was created

":
"{Datetime}",
5
          "status
Status

Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed

Possible domain values can be found here

":
"{Integer}",
6
          "description
Description

Description of quality issue

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

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

Possible domain values can be found here

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

Title of the issue

":
"{String}",
9
          "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

Possible domain values can be found here

":
"{Integer}",
10
          "occuredAt
OccuredAt

Time and date when the issue occured

":
"{Datetime}",
11
          "registeredAt
RegisteredAt

Time and date when this issue was registered

":
"{Datetime}",
12
          "dueDate
DueDate

Time and date when this issue should be resolved

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

Time and date when this issue was resolved

":
"{Datetime}",
14
          "riskScore
RiskScore

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

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

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

":
"{Boolean}",
16
          "notifyWhenClosed
NotifyWhenClosed

If true, a notification will be sent to the creator when closing this issue.

":
"{Boolean}",
17
          "externalReference
ExternalReference

External reference identifier from the customer

":
"{String}",
18
          "externalTitle
ExternalTitle

External title used in external correspondence. Is used in order to send modified title of quality issue to customer

":
"{String}",
19
          "requireReview
RequireReview

True if this issue requires a review. False if not

":
"{Boolean}",
20
          "closeComment
CloseComment

Additional comment added by person who closes quality issue.

":
"{String}",
21
          "reviewComment
ReviewComment

Comment added by reviewer when they rejected review and typed some suggestions.

":
"{String}",
22
          "reviewedAt
ReviewedAt

Date and time when quality issue was reviewed.

":
"{Datetime}",
23
          "folder": {
24
               "folderId
FolderId

File folder id for a spesific file container or forlder.

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

Verbose folder text in english.

":
"{String}",
26
               "folderLink
FolderLink

Company folder id

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

Name of the issue reporter

":
"{String}",
28
               "object": {
29
                    "objectType
ObjectType

Type of object

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

Identifier of the object

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

API reference to the object

":
"{String}"
32
               },
33
               "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

":
"{String}"
36
          },
37
          "totals": {
38
               "currency
Currency

Three character code following the ISO 4217 standard

":
"{String}",
39
               "totalCost
TotalCost

Total cost of the issue

":
"{Decimal}",
40
               "qualityIssueActionsCount
QualityIssueActionsCount

Count of all immediate and corrective actions.

":
"{Integer}",
41
               "doneQualityIssueActionsCount
DoneQualityIssueActionsCount

Count of done immediate and corrective actions.

":
"{Integer}",
42
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

":
"{String}",
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
               "userId
UserId

User identifier

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

First name of the user

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

Name of the user

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

User reference

":
"{String}",
54
               "userId
UserId

User identifier

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

First name of the user

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

Name of the user

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

User reference

":
"{String}",
58
               "departmentId
DepartmentId

Department identifier

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

Name of department

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

Finance department reference

":
"{String}",
61
               "affectedQuantity
AffectedQuantity

Quantity of product units affected by this quality issue.

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

The quantity that will be (or has been) produced

":
"{Integer}",
63
               "source": {
64
                    "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

":
"{String}",
67
                    "itemId
ItemId

Item-number of the object

":
"{Integer}",
68
                    "itemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

":
"{String}"
70
               },
71
               "financeProject": {
72
                    "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

Finance project reference

":
"{String}"
75
               },
76
               "product": {
77
                    "productId
ProductId

Product identifier

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

Name of the product

":
"{String}",
79
                    "description
Description

Description of the product

":
"{String}",
80
                    "productClassification": {
81
                         "productClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

":
"{String}"
83
                    },
84
                    "productLink
ProductLink

Product reference

":
"{String}",
85
                    "revision
Revision

The Revision of the product

":
"{String}",
86
                    "productStructureVersionId
ProductStructureVersionId

Product structure identifier

":
"{Integer}",
87
                    "drawing
Drawing

Drawing of the product structure

":
{
88
                         "database
Database

Database of the object

":
"{String}",
89
                         "fileVersionId
FileVersionId

File identifier

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

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

":
"{String}",
91
                         "fileVersionLink
FileVersionLink

File reference

":
"{String}"
92
                    },
93
                    "productStructure": {
94
                         "productStructureId
ProductStructureId

Product structure identifier

":
"{Long}"
95
                    },
96
                    "productStructureVersionLink
ProductStructureVersionLink

Product structure reference

":
"{String}"
97
               },
98
               "customer": {
99
                    "customerId
CustomerId

Customer identifier

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

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

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

Customer reference

":
"{String}"
102
               },
103
               "supplier": {
104
                    "supplierId
SupplierId

RamBase supplier identifier

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

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

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

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

":
"{String}"
107
               },
108
               "productionResource": {
109
                    "productionResourceId
ProductionResourceId

Production resource identifier

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

Name of production resource

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

Production resource reference

":
"{String}"
112
               },
113
               "salesOrder": {
114
                    "salesOrderId
SalesOrderId

Sales order identifier

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

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

":
"{String}",
116
                    "customer": {
117
                         "customerId
CustomerId

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

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

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

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

Customer reference

":
"{String}"
120
                    },
121
                    "salesOrderLink
SalesOrderLink

Sales order reference

":
"{String}"
122
               },
123
               "salesOrderItem": {
124
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

":
"{Integer}",
125
                    "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

":
"{String}"
126
               },
127
               "manufacturer": {
128
                    "manufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

Manufacturer reference

":
"{String}"
131
               },
132
               "detectedOnOperation": {
133
                    "productionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Production operation reference

":
"{String}"
136
               },
137
               "occurredOnOperation": {
138
                    "productionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Production operation reference

":
"{String}"
141
               },
142
               "material": {
143
                    "productId
ProductId

Product identifier

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

Name of the product

":
"{String}",
145
                    "description
Description

Description of the product

":
"{String}",
146
                    "productClassification": {
147
                         "productClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

":
"{String}"
149
                    },
150
                    "productLink
ProductLink

Product reference

":
"{String}"
151
               },
152
               "productionWorkOrder": {
153
                    "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

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

Production work order reference

":
"{String}"
155
               },
156
               "purchaseOrder": {
157
                    "purchaseOrderId
PurchaseOrderId

Purchase order identifier

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

Purchase order reference

":
"{String}"
159
               },
160
               "purchaseOrderItem": {
161
                    "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

":
"{Integer}",
162
                    "purchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

":
"{String}"
163
               }
164
          }
165
     }
166
}

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 101606 HTTP 404 Module not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}
Error 105912 HTTP 400 Source cannot be found
Error 106156 HTTP 400 Department cannot be empty.
Error 106155 HTTP 400 OccuredAt cannot be empty.
Error 105858 HTTP 400 Responsible cannot be empty.