Quality management APIs
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.
Description
Description of quality issue
This field is optional.
>{String}</Description>Type
Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"
Applicable domain values can be found here
This field is optional.
>{Integer}</Type>Title
Required/mandatory field
Title of the issue
>{String}</Title>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>OccuredAt
Time and date when the issue occured
This field is optional.
>{Datetime}</OccuredAt>DueDate
Time and date when this issue should be resolved
This field is optional.
>{Date}</DueDate>RequireReview
True if this issue requires a review. False if not
Default value: False
This field is optional.
>{Boolean}</RequireReview>NotifyWhenClosed
If true, a notification will be sent to the creator when closing this issue.
Default value: False
This field is optional.
>{Boolean}</NotifyWhenClosed>CreateAnonymously
True, when issue should be created anonymously, otherwise False.
Default value: False
This field is optional.
>{Boolean}</CreateAnonymously>ExternalReference
External reference identifier from the customer
This field is optional.
>{String}</ExternalReference>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>Folder
This field is optional.
>FolderId
File folder id for a spesific file container or forlder.
Minimum value: 100000
This field is optional.
>{Integer}</FolderId>ReportedBy
This field is optional.
>Object
This field is optional.
>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>ObjectId
Identifier of the object
Minimum value: 1
This field is optional.
>{Integer}</ObjectId>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>Responsible
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Assignee
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Department
This field is optional.
>DepartmentId
Department identifier
Minimum value: 1
This field is optional.
>{Integer}</DepartmentId>Context
This field is optional.
>Source
This field is optional.
>ObjectId
Identifier of the object
This field is optional.
>{Integer}</ObjectId>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>ItemId
Item-number of the object
This field is optional.
>{Integer}</ItemId>Description
Description of quality issue
This field is optional.
": "{String}",Type
Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"
Applicable domain values can be found here
This field is optional.
": "{Integer}",Title
Required/mandatory field
Title of the issue
": "{String}",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}",OccuredAt
Time and date when the issue occured
This field is optional.
": "{Datetime}",DueDate
Time and date when this issue should be resolved
This field is optional.
": "{Date}",RequireReview
True if this issue requires a review. False if not
Default value: False
This field is optional.
": "{Boolean}",NotifyWhenClosed
If true, a notification will be sent to the creator when closing this issue.
Default value: False
This field is optional.
": "{Boolean}",CreateAnonymously
True, when issue should be created anonymously, otherwise False.
Default value: False
This field is optional.
": "{Boolean}",ExternalReference
External reference identifier from the customer
This field is optional.
": "{String}",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}",Folder
This field is optional.
": {FolderId
File folder id for a spesific file container or forlder.
Minimum value: 100000
This field is optional.
": "{Integer}"ReportedBy
This field is optional.
": {Object
This field is optional.
": {ObjectType
Type of object
This field is optional.
": "{String}",ObjectId
Identifier of the object
Minimum value: 1
This field is optional.
": "{Integer}"Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Responsible
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"Assignee
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"Department
This field is optional.
": {DepartmentId
Department identifier
Minimum value: 1
This field is optional.
": "{Integer}"Context
This field is optional.
": {Source
This field is optional.
": {ObjectId
Identifier of the object
This field is optional.
": "{Integer}",ObjectType
Type of object
This field is optional.
": "{String}",ItemId
Item-number of the object
This field is optional.
": "{Integer}"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.
QualityIssueId
Quality issue identifier
>{Integer}</QualityIssueId>CreatedAt
Date and time when quality issue was created
>{Datetime}</CreatedAt>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>Description
Description of quality issue
>{String}</Description>Type
Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"
Possible domain values can be found here
>{Integer}</Type>Title
Title of the issue
>{String}</Title>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>OccuredAt
Time and date when the issue occured
>{Datetime}</OccuredAt>RegisteredAt
Time and date when this issue was registered
>{Datetime}</RegisteredAt>DueDate
Time and date when this issue should be resolved
>{Date}</DueDate>ClosedAt
Time and date when this issue was resolved
>{Datetime}</ClosedAt>RiskScore
A calculated score of how much of a risk this issue indicates. It is the product of likelihood and rating (severity)
>{Integer}</RiskScore>IsMarkedForNCR
Whether or not an issue is marked as non conformance report (NCR)
>{Boolean}</IsMarkedForNCR>NotifyWhenClosed
If true, a notification will be sent to the creator when closing this issue.
>{Boolean}</NotifyWhenClosed>ExternalReference
External reference identifier from the customer
>{String}</ExternalReference>ExternalTitle
External title used in external correspondence. Is used in order to send modified title of quality issue to customer
>{String}</ExternalTitle>RequireReview
True if this issue requires a review. False if not
>{Boolean}</RequireReview>CloseComment
Additional comment added by person who closes quality issue.
>{String}</CloseComment>ReviewComment
Comment added by reviewer when they rejected review and typed some suggestions.
>{String}</ReviewComment>ReviewedAt
Date and time when quality issue was reviewed.
>{Datetime}</ReviewedAt>FolderId
File folder id for a spesific file container or forlder.
>{Integer}</FolderId>Name
Verbose folder text in english.
>{String}</Name>FolderLink
Company folder id
>{String}</FolderLink>Name
Name of the issue reporter
>{String}</Name>ObjectType
Type of object
>{String}</ObjectType>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectLink
API reference to the object
>{String}</ObjectLink>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TotalCost
Total cost of the issue
>{Decimal}</TotalCost>QualityIssueActionsCount
Count of all immediate and corrective actions.
>{Integer}</QualityIssueActionsCount>DoneQualityIssueActionsCount
Count of done immediate and corrective actions.
>{Integer}</DoneQualityIssueActionsCount>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>DepartmentId
Department identifier
>{Integer}</DepartmentId>Name
Name of department
>{String}</Name>DepartmentLink
Finance department reference
>{String}</DepartmentLink>AffectedQuantity
Quantity of product units affected by this quality issue.
>{Integer}</AffectedQuantity>TotalQuantity
The quantity that will be (or has been) produced
>{Integer}</TotalQuantity>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>Name
Name of finance project
>{String}</Name>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>ProductLink
Product reference
>{String}</ProductLink>Revision
The Revision of the product
>{String}</Revision>ProductStructureVersionId
Product structure identifier
>{Integer}</ProductStructureVersionId>Drawing
Drawing of the product structure
>Database
Database of the object
>{String}</Database>FileVersionId
File identifier
>{String}</FileVersionId>FileName
Filename to display for the file version. Will be used when downloading the file.
>{String}</FileName>FileVersionLink
File reference
>{String}</FileVersionLink>ProductStructureId
Product structure identifier
>{Long}</ProductStructureId>ProductStructureVersionLink
Product structure reference
>{String}</ProductStructureVersionLink>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>CustomerLink
Customer reference
>{String}</CustomerLink>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>SupplierLink
Supplier general ledger account is the default account that should be used on incoming invoices for this supplier.
>{String}</SupplierLink>ProductionResourceId
Production resource identifier
>{Integer}</ProductionResourceId>Name
Name of production resource
>{String}</Name>ProductionResourceLink
Production resource reference
>{String}</ProductionResourceLink>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
>{String}</CustomersReferenceNumber>CustomerId
Customers reference number. E.g. the internal sales order id the customer use in their own system.
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>CustomerLink
Customer reference
>{String}</CustomerLink>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>SalesOrderItemLink
Reference to the sales order item.
>{String}</SalesOrderItemLink>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>Name
Company name of the manufacturer.
>{String}</Name>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>ProductLink
Product reference
>{String}</ProductLink>ProductionWorkOrderId
Production work order identifier
>{Integer}</ProductionWorkOrderId>ProductionWorkOrderLink
Production work order reference
>{String}</ProductionWorkOrderLink>PurchaseOrderId
Purchase order identifier
>{Integer}</PurchaseOrderId>PurchaseOrderLink
Purchase order reference
>{String}</PurchaseOrderLink>PurchaseOrderItemId
Item-/line-number of the purchase order
>{Integer}</PurchaseOrderItemId>PurchaseOrderItemLink
Purchase order item reference
>{String}</PurchaseOrderItemLink>QualityIssueId
Quality issue identifier
": "{Integer}",CreatedAt
Date and time when quality issue was created
": "{Datetime}",Status
Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed
Possible domain values can be found here
": "{Integer}",Description
Description of quality issue
": "{String}",Type
Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"
Possible domain values can be found here
": "{Integer}",Title
Title of the issue
": "{String}",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}",OccuredAt
Time and date when the issue occured
": "{Datetime}",RegisteredAt
Time and date when this issue was registered
": "{Datetime}",DueDate
Time and date when this issue should be resolved
": "{Date}",ClosedAt
Time and date when this issue was resolved
": "{Datetime}",RiskScore
A calculated score of how much of a risk this issue indicates. It is the product of likelihood and rating (severity)
": "{Integer}",IsMarkedForNCR
Whether or not an issue is marked as non conformance report (NCR)
": "{Boolean}",NotifyWhenClosed
If true, a notification will be sent to the creator when closing this issue.
": "{Boolean}",ExternalReference
External reference identifier from the customer
": "{String}",ExternalTitle
External title used in external correspondence. Is used in order to send modified title of quality issue to customer
": "{String}",RequireReview
True if this issue requires a review. False if not
": "{Boolean}",CloseComment
Additional comment added by person who closes quality issue.
": "{String}",ReviewComment
Comment added by reviewer when they rejected review and typed some suggestions.
": "{String}",ReviewedAt
Date and time when quality issue was reviewed.
": "{Datetime}",FolderId
File folder id for a spesific file container or forlder.
": "{Integer}",Name
Verbose folder text in english.
": "{String}",FolderLink
Company folder id
": "{String}",Name
Name of the issue reporter
": "{String}",ObjectType
Type of object
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectLink
API reference to the object
": "{String}"LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",TotalCost
Total cost of the issue
": "{Decimal}",QualityIssueActionsCount
Count of all immediate and corrective actions.
": "{Integer}",DoneQualityIssueActionsCount
Count of done immediate and corrective actions.
": "{Integer}",EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}",EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}",UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}",UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}",DepartmentId
Department identifier
": "{Integer}",Name
Name of department
": "{String}",DepartmentLink
Finance department reference
": "{String}",AffectedQuantity
Quantity of product units affected by this quality issue.
": "{Integer}",TotalQuantity
The quantity that will be (or has been) produced
": "{Integer}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"FinanceProjectId
Finance project identifier
": "{Integer}",Name
Name of finance project
": "{String}",FinanceProjectLink
Finance project reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"ProductLink
Product reference
": "{String}",Revision
The Revision of the product
": "{String}",ProductStructureVersionId
Product structure identifier
": "{Integer}",Drawing
Drawing of the product structure
": {Database
Database of the object
": "{String}",FileVersionId
File identifier
": "{String}",FileName
Filename to display for the file version. Will be used when downloading the file.
": "{String}",FileVersionLink
File reference
": "{String}"ProductStructureId
Product structure identifier
": "{Long}"ProductStructureVersionLink
Product structure reference
": "{String}"CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",CustomerLink
Customer reference
": "{String}"SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
Supplier general ledger account is the default account that should be used on incoming invoices for this supplier.
": "{String}"ProductionResourceId
Production resource identifier
": "{Integer}",Name
Name of production resource
": "{String}",ProductionResourceLink
Production resource reference
": "{String}"SalesOrderId
Sales order identifier
": "{Integer}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
": "{String}",CustomerId
Customers reference number. E.g. the internal sales order id the customer use in their own system.
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",CustomerLink
Customer reference
": "{String}"SalesOrderLink
Sales order reference
": "{String}"SalesOrderItemId
Sales order item identifier
": "{Integer}",SalesOrderItemLink
Reference to the sales order item.
": "{String}"ManufacturerId
Manufacturer identifier
": "{Integer}",Name
Company name of the manufacturer.
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",ProductionOperationLink
Production operation reference
": "{String}"ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",ProductionOperationLink
Production operation reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"ProductLink
Product reference
": "{String}"ProductionWorkOrderId
Production work order identifier
": "{Integer}",ProductionWorkOrderLink
Production work order reference
": "{String}"PurchaseOrderId
Purchase order identifier
": "{Integer}",PurchaseOrderLink
Purchase order reference
": "{String}"PurchaseOrderItemId
Item-/line-number of the purchase order
": "{Integer}",PurchaseOrderItemLink
Purchase order item reference
": "{String}"
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. |