User settings APIs

Users at companies that own or link to Agile Process Teams use this API to define when they are automatically added as a follower to a process. These settings apply to the user whose credentials are used in the request and apply to all processes (e.g. incidents, change requests) that the user has access to in the specific network.

When a process meets the defined criteria and the user is added as a follower, they will receive notifications for the process. For example, a quality compliance manager might want updates to processes related to the CMO locations that have caused the most incidents in the past year, so they choose to automatically follow all processes that reference those specific location IDs.

Users can manually start or stop following a specific process using the Toggle User Follows Incident API or Toggle User Follows Change API.

Edit User Settings

Owners and Partners use this API to edit the settings that define when the user is automatically added as a follower to Agile Process Teams processes (e.g. incidents, change requests).

Guidelines

  Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is agile-process-teams:edit-user-settings:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is agile-process-teams.
  processNetworkId String Required. The network that contains the processes the user settings apply to. This must be a valid network at the Owner company.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The response header.
  followAddedByMe Boolean

Indicates whether the user is automatically added as a follower to all processes they add to the network via add or copy. Valid values:

  • true – (default) The user is automatically added as a follower to processes they add.
  • false – The user is not automatically added as a follower to processes they add.
  followCommentedByMe Boolean

Indicates whether the user is automatically added as a follower to all processes they comment on or add an attachment to. Valid values:

  • true – The user is automatically added as a follower to processes they comment on or add an attachment to.
  • false – (default) The user is not automatically added as a follower to processes they comment on or add an attachment to.
  followModifiedByMe Boolean

Indicates whether the user is automatically added as a follower to all processes they modify. Valid values:

  • true – The user is automatically added as a follower to processes they modify.
  • false – (default) The user is not automatically added as a follower to processes they modify.
Modifying a process does not include commenting or adding an attachment.
  followAssignedToMe Boolean

Indicates whether the user is automatically added as a follower to processes they are assigned to as a responsiblePartyAtCompany or responsiblePartyAtPartner or as one of the currentlyAssignedCompanyUsers or currentlyAssignedPartnerUsers. Valid values:

  • true – The user is automatically added as a follower to processes they are assigned to.
  • false – (default) The user is not automatically added as a follower to processes they are assigned to.
  followProducts Array

One or more item codes or packaging codes for specific products, sourced from Master Data Exchange. The user is automatically added as a follower to all processes that reference the products as available replacement materials, impacted products, or potentially impacted products.
  followLocations Array

One or more identifiers for a specific Owner or Partner companies or locations, sourced from Master Data Exchange. The user is automatically added as a follower to all processes that reference the companies or locations as originating companies or locations, Partner companies or locations, impacted locations, or potentially impacted locations.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-user-settings:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "processNetworkId": "945feb8e-09a7-4fef-9a8a-b3c5b56f87d",
        "appName": "agile-process-teams",
        "dataspace": "default"
    },
    "payload": {
        "followModifiedByMe": true,
        "followProducts": [
            "dcceedb1-fc3c-45d8-9d45-9e159f901d2c",
            "11935532-e603-4700-9aed-b14b4ac2a7d8",
            "7713c743-dd56-4074-83f3-c961b52b1519"
        ]
    }
}

Guidelines

  Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is agile-process-teams:edit-user-settings-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful.

Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String Conditionally required if the call is unsuccessful. The message associated with the error code (e.g. "Process Network ID is required.").
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception thrown based on the error code.

Valid values:
  • 400 BadRequestException – The request is missing fields or has invalid data.
  • 404 NotFoundException – The request is referencing an object that APT cannot find.
payload – Required. Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  userId String The ID for the user the updated settings successfully apply to.
  aptUserPreferenceId String The unique ID for the updated user settings object.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "agile-process-teams:edit-user-settings-response:v1",
        "ownerId": "94f94f37-2772-4b39-8041-9c2dcfcfff82",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "vXPsFz"
    },
    "payload": {
        "userId": "a67d7261-33b1-4be6-9760-61ae8fe9eed3",
        "aptUserPreferenceId": "dcceedb1-fc3c-45d8-9d45-9e159f901d2c"
    }
}

Errors

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.