API

Quality management APIs

POST quality/issues/{qualityIssueId}/suggested-actions

Creates a new suggested action.

HTTP method POST
URI https://api.rambase.net/quality/issues/{qualityIssueId}/suggested-actions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {qualityIssueId} Quality issue identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 4660, version 1

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
<QualityIssueSuggestedAction>
2
     <Title
Title

Required/mandatory field

Title of a suggested action.

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

Description of a suggested action.

This field is optional.

>
{String}</Description>
4
</QualityIssueSuggestedAction>
1
{
2
     "qualityIssueSuggestedAction": {
3
          "title
Title

Required/mandatory field

Title of a suggested action.

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

Description of a suggested action.

This field is optional.

":
"{String}"
5
     }
6
}

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.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

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
<QualityIssueSuggestedAction>
2
     <QualityIssueSuggestedActionId
QualityIssueSuggestedActionId

Suggested action identifier.

>
{Integer}</QualityIssueSuggestedActionId>
3
     <Title
Title

Title of a suggested action.

>
{String}</Title>
4
     <Description
Description

Description of a suggested action.

>
{String}</Description>
5
     <AddedAt
AddedAt

Date and time when this suggested action was added.

>
{Datetime}</AddedAt>
6
     <IsRejected
IsRejected

Tells if suggested action was rejected

>
{Boolean}</IsRejected>
7
     <AddedBy>
8
          <UserId
UserId

User identifier

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

User reference

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

Name of the user

>
{String}</Name>
11
     </AddedBy>
12
</QualityIssueSuggestedAction>
1
{
2
     "qualityIssueSuggestedAction": {
3
          "qualityIssueSuggestedActionId
QualityIssueSuggestedActionId

Suggested action identifier.

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

Title of a suggested action.

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

Description of a suggested action.

":
"{String}",
6
          "addedAt
AddedAt

Date and time when this suggested action was added.

":
"{Datetime}",
7
          "isRejected
IsRejected

Tells if suggested action was rejected

":
"{Boolean}",
8
          "addedBy": {
9
               "userId
UserId

User identifier

":
"{Integer}",
10
               "userLink
UserLink

User reference

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

Name of the user

":
"{String}"
12
          }
13
     }
14
}

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 105778 HTTP 404 Issue not found.
Error 105861 HTTP 404 Issue action not found
Error 106066 HTTP 400 Action is not of type suggested action.