API

Quality management APIs

PUT quality/issues/{qualityIssueId}

Update a Quality Issue

HTTP method PUT
URI https://api.rambase.net/quality/issues/{qualityIssueId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {qualityIssueId} Quality issue identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 4470, version 33

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
QualityIssue

This field is optional.

>
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

Title of the issue

This field is optional.

>{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
     <ExternalReference
ExternalReference

External reference identifier from the customer

This field is optional.

>{String}</ExternalReference>
9
     <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>
10
     <RequireReview
RequireReview

True if this issue requires a review. False if not

This field is optional.

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

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

This field is optional.

>{Boolean}</NotifyWhenClosed>
12
     <ReportedBy
ReportedBy

This field is optional.

>
13
          <Object
Object

This field is optional.

>
14
               <ObjectType
ObjectType

Type of object

This field is optional.

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

Identifier of the object

Minimum value: 1

This field is optional.

>{Integer}</ObjectId>
16
          </Object>
17
     </ReportedBy>
18
     <Location
Location

This field is optional.

>
19
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
20
     </Location>
21
     <Responsible
Responsible

This field is optional.

>
22
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
23
     </Responsible>
24
     <Assignee
Assignee

This field is optional.

>
25
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
26
     </Assignee>
27
     <Department
Department

This field is optional.

>
28
          <DepartmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

>{Integer}</DepartmentId>
29
     </Department>
30
     <Context
Context

This field is optional.

>
31
          <AffectedQuantity
AffectedQuantity

Quantity of product units affected by this quality issue.

Minimum value: 0

This field is optional.

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

The quantity that will be (or has been) produced

Minimum value: 0

This field is optional.

>{Integer}</TotalQuantity>
33
          <Source
Source

This field is optional.

>
34
               <ObjectId
ObjectId

Identifier of the object

This field is optional.

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

Type of object

This field is optional.

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

Item-number of the object

This field is optional.

>{Integer}</ItemId>
37
          </Source>
38
          <FinanceProject
FinanceProject

This field is optional.

>
39
               <FinanceProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

>{Integer}</FinanceProjectId>
40
          </FinanceProject>
41
          <Product
Product

This field is optional.

>
42
               <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
43
          </Product>
44
          <Customer
Customer

This field is optional.

>
45
               <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>{Integer}</CustomerId>
46
          </Customer>
47
          <Supplier
Supplier

This field is optional.

>
48
               <SupplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

>{Integer}</SupplierId>
49
          </Supplier>
50
          <ProductionResource
ProductionResource

This field is optional.

>
51
               <ProductionResourceId
ProductionResourceId

Production resource identifier

Minimum value: 100000

This field is optional.

>{Integer}</ProductionResourceId>
52
          </ProductionResource>
53
          <SalesOrder
SalesOrder

This field is optional.

>
54
               <SalesOrderId
SalesOrderId

Sales order identifier

Minimum value: 100000

This field is optional.

>{Integer}</SalesOrderId>
55
          </SalesOrder>
56
          <SalesOrderItem
SalesOrderItem

This field is optional.

>
57
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

Minimum value: 1

This field is optional.

>{Integer}</SalesOrderItemId>
58
          </SalesOrderItem>
59
          <Manufacturer
Manufacturer

This field is optional.

>
60
               <ManufacturerId
ManufacturerId

Manufacturer identifier

Minimum value: 1000

This field is optional.

>{Integer}</ManufacturerId>
61
          </Manufacturer>
62
          <DetectedOnOperation
DetectedOnOperation

This field is optional.

>
63
               <ProductionOperationId
ProductionOperationId

Production operation identifier

Minimum value: 1000

This field is optional.

>{Integer}</ProductionOperationId>
64
          </DetectedOnOperation>
65
          <OccurredOnOperation
OccurredOnOperation

This field is optional.

>
66
               <ProductionOperationId
ProductionOperationId

Production operation identifier

Minimum value: 1000

This field is optional.

>{Integer}</ProductionOperationId>
67
          </OccurredOnOperation>
68
          <Material
Material

This field is optional.

>
69
               <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
70
          </Material>
71
          <ProductionWorkOrder
ProductionWorkOrder

This field is optional.

>
72
               <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

Minimum value: 100000

This field is optional.

>{Integer}</ProductionWorkOrderId>
73
          </ProductionWorkOrder>
74
          <PurchaseOrder
PurchaseOrder

This field is optional.

>
75
               <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

Minimum value: 100000

This field is optional.

>{Integer}</PurchaseOrderId>
76
          </PurchaseOrder>
77
          <PurchaseOrderItem
PurchaseOrderItem

This field is optional.

>
78
               <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

Minimum value: 1

This field is optional.

>{Integer}</PurchaseOrderItemId>
79
          </PurchaseOrderItem>
80
     </Context>
81
</QualityIssue>
1
{
2
     "qualityIssue
QualityIssue

This field is optional.

": {
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

Title of the issue

This field is optional.

": "{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
          "externalReference
ExternalReference

External reference identifier from the customer

This field is optional.

": "{String}",
10
          "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}",
11
          "requireReview
RequireReview

True if this issue requires a review. False if not

This field is optional.

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

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

This field is optional.

": "{Boolean}",
13
          "reportedBy
ReportedBy

This field is optional.

": {
14
               "object
Object

This field is optional.

": {
15
                    "objectType
ObjectType

Type of object

This field is optional.

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

Identifier of the object

Minimum value: 1

This field is optional.

": "{Integer}"
17
               }
18
          },
19
          "location
Location

This field is optional.

": {
20
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
21
          },
22
          "responsible
Responsible

This field is optional.

": {
23
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
24
          },
25
          "assignee
Assignee

This field is optional.

": {
26
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
27
          },
28
          "department
Department

This field is optional.

": {
29
               "departmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

": "{Integer}"
30
          },
31
          "context
Context

This field is optional.

": {
32
               "affectedQuantity
AffectedQuantity

Quantity of product units affected by this quality issue.

Minimum value: 0

This field is optional.

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

The quantity that will be (or has been) produced

Minimum value: 0

This field is optional.

": "{Integer}",
34
               "source
Source

This field is optional.

": {
35
                    "objectId
ObjectId

Identifier of the object

This field is optional.

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

Type of object

This field is optional.

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

Item-number of the object

This field is optional.

": "{Integer}"
38
               },
39
               "financeProject
FinanceProject

This field is optional.

": {
40
                    "financeProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

": "{Integer}"
41
               },
42
               "product
Product

This field is optional.

": {
43
                    "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
44
               },
45
               "customer
Customer

This field is optional.

": {
46
                    "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
47
               },
48
               "supplier
Supplier

This field is optional.

": {
49
                    "supplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

": "{Integer}"
50
               },
51
               "productionResource
ProductionResource

This field is optional.

": {
52
                    "productionResourceId
ProductionResourceId

Production resource identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
53
               },
54
               "salesOrder
SalesOrder

This field is optional.

": {
55
                    "salesOrderId
SalesOrderId

Sales order identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
56
               },
57
               "salesOrderItem
SalesOrderItem

This field is optional.

": {
58
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

Minimum value: 1

This field is optional.

": "{Integer}"
59
               },
60
               "manufacturer
Manufacturer

This field is optional.

": {
61
                    "manufacturerId
ManufacturerId

Manufacturer identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
62
               },
63
               "detectedOnOperation
DetectedOnOperation

This field is optional.

": {
64
                    "productionOperationId
ProductionOperationId

Production operation identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
65
               },
66
               "occurredOnOperation
OccurredOnOperation

This field is optional.

": {
67
                    "productionOperationId
ProductionOperationId

Production operation identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
68
               },
69
               "material
Material

This field is optional.

": {
70
                    "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
71
               },
72
               "productionWorkOrder
ProductionWorkOrder

This field is optional.

": {
73
                    "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
74
               },
75
               "purchaseOrder
PurchaseOrder

This field is optional.

": {
76
                    "purchaseOrderId
PurchaseOrderId

Purchase order identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
77
               },
78
               "purchaseOrderItem
PurchaseOrderItem

This field is optional.

": {
79
                    "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

Minimum value: 1

This field is optional.

": "{Integer}"
80
               }
81
          }
82
     }
83
}

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.
$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. 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
1

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 101420 HTTP 404 Setting definition not 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.