NAV

Introduction

This is the developers documentation site to integrate Rever with your internal systems and get the most out of the data generated in your organization.

Email: Support

Webhooks

After you register a HTTP URL in your Rever Organization settings using our Web platform, you should be able to susbscribe your systems to receive the data related to specific events.

For more info about how to register a new Webhook URL please refer to our help article.

Your server can expect the following headers and payload structure for each Incoming Webhook request:

Headers

Name Value/Description
Accept application/json, text/plain, /
Content-Type application/json;charset=utf-8
User-Agent rever-webhooks
X-Rever-DebugId A UUID for debugging purposes in case any problem arises
X-Rever-Webhook-Signature A hash value generated from the combination of the payload and the configured secret. If no secret was configured this header is omitted.
X-Rever-Webhook-Delivery-Timestamp Timestamp for the incoming Webhook event

Payload

Payload example:

{
  "id": "6454bf7f-31d5-46ff-99d9-4925e630ad0e",
  "event": "revCreated",
  "resource": {
    "id": "dee8adcd-febb-44ae-bae2-6f388c043037",
    "type": "quickAction",
    "version": "1",
    "currentVersion": { ... Resource data },
    "previousVersion": null
  },
  "debugId": "07d63710e89211eab8f3b518a6b12950",
  "createdAt": "2020-08-27T18:20:48.475Z",
  "createdAtTimestamp": 1598552448475
}
Property Type Description
id string(uuid) Webhook's request id
event string Event's type id
resource object A generic object with resource specific data
debugId string Same debug id sent in the X-Rever-LogId header.
createdAt string(date-time) Event date-time string in ISO format
createdAtTimestamp integer Event timestamp

Payload Enumerated Values

Property Value
event revCreated
event revUpdated
event revDeleted
event challengeCreated

Resource Object

Property Type Description
id string(uuid) Resource Id
type string
contractVersion string Similar resource schemas can be expected for the same contract version.
currentVersion object/null Object with resource details. A null value is returned in deletion events.
previousVersion object/null Object with resource details. A null value is returned in creation events.

Resource Enumerated Values

Property Value
type improvementIdea
type quickAction
type problemSolving
type challenge

Revs resource details

{
  "name": "string",
  "categories": ["string"],
  "team": {
    "owner": {},
    "coach": {},
    "collaborators": [{}]
  },
  "location": {},
  "currentPhase": "string",
  "details": {
    "id": "string"
  }
}

Resources with a type equals to improvementIdea, quickAction or problemSolving are considered "Revs".

Below you can find the specification for Rev resources, please note that the property details contains a full representation of the specific type of Rev, while other properties where placed in a top-level for being considered of interest.

For more details about each Rev schema please refer to the Schemas section.

Name Type Description
name string none
categories [string] none
team object none
location location none
status string none
currentPhase string none
details object The full Rev data. Its schema depends on the value specified in the resource.type property

Challenges resource details

For resources with a type equals to challenge you can expect to receive only a Challenge object, unlike Rev resources in which case this data structure would be expected in the details property.

Open API

This section will describe how to query and consume the stream to integrate Rever with external systems, this is what we recommend for integration with Business Intelligence software.

Authentication

curl --location --request POST 'https://api.reverscore.net/api/v1/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email":"xxxxxx@xxxxxxx.com",
    "password":"xxxxxxxxxxx"
}'

To use our API you first need to obtain an access token, this token is required by most of our endpoints:

HTTP Request

POST https://api.reverscore.net/api/v1/login

Payload

Property Description
email account email
password account password

Payload example:

{
    "email":"name@domain.com",
    "password":"xxxxxxxx"
}

Replace your email and password

Response

response example:

{
    "ttl": 1608657550729,
    "accessToken": "xxxxxx-xxxxx-xxx-xxx-xxxxxx",
    "userId": "userId",
    "created": "2020-12-08T17:19:10.735Z",
    "updatedAt": "2020-12-08T17:19:10.735Z",
    "_id": "xxxxxx-xxxxx-xxx-xxx-xxxxxx",
    "account": { ...account object }
}

From the response you cant extract the accessToken, from the Account Object you can also extract your organizationId

The access token needs to be present in the header in all other calls:

--header 'Authorization: xxxxxx-xxxxx-xxx-xxx-xxxxxx'

Get Revs

Replace xxxxxxxxxxxxx with your accessToken, and :organizationId with your organizationId

curl --location --request GET 'https://api.reverscore.net/api/v1/stream/:organizationId/revs?limit=50&from=100' \
--header 'Authorization: xxxxxxxxxxxxx'

In this example we are getting the second page, where each page has 50 items

HTTP Request

GET https://api.reverscore.net/api/v1/stream/:organizationId/revs

Get the list of Revs

Query params

For pagination

Parameter Default Description
limit 20 number of items per page
from 0 number of records of where to start the page

Example Response

{
  "results": [ { ...Object Data }, ],
  "totalResults": 50,
  "totalRecordsInData": 1487
}

Get Challenges

Replace xxxxxxxxxxxxx with your accessToken, and :organizationId with your organizationId

curl --location --request GET 'https://api.reverscore.net/api/v1/stream/:organizationId/challenges?limit=30' \
--header 'Authorization: xxxxxxxxxxxx'

HTTP Request

GET https://api.reverscore.net/api/v1/stream/:organizationId/challenges

Get the list of Challenges

Query params

For pagination

Parameter Default Description
limit 20 number of items per page
from 0 number of records of where to start the page

Example Response

{
  "results": [ { ...Object Data }, ],
  "totalResults": 50,
  "totalRecordsInData": 1487
}

Get Revs in challenges

Replace xxxxxxxxxxxxx with your accessToken, and :organizationId with your organizationId and :challengeId with the id of the challenge

curl --location --request GET 'https://api.reverscore.net/api/v1/organizations/:organizationId/challenges/:challengeId/revs?page=1&limit=20' \
--header 'xxxxxxxxxxxxx'

Query params

For pagination

Parameter Default Description
limit 20 number of items per page
page 0 number of page to get

Get Accounts

Replace xxxxxxxxxxxxx with your accessToken, and :organizationId with your organizationId

curl --location --request GET 'https://api.reverscore.net/api/v1/stream/:organizationId/accounts?limit=30' \
--header 'Authorization: xxxxxxxxxxxx'

HTTP Request

GET https://api.reverscore.net/api/v1/stream/:organizationId/accounts

Get the list of Accounts

Query params

For pagination

Parameter Default Description
limit 20 number of items per page
from 0 number of records of where to start the page

Example Response

{
  "results": [ { ...Object Data }, ],
  "totalResults": 50,
  "totalRecordsInData": 1487
}

Get Organization Tree

Replace xxxxxxxxxxxxx with your accessToken, and :organizationId with your organizationId

curl --location --request GET 'https://api.reverscore.net/api/v1/organizations/:organizationId/tree' \
--header 'Authorization: xxxxxxxxxxxxx'

HTTP Request

GET https://api.reverscore.net/api/v1/organizations/:organizationId/tree

This will get you the Tree of your organization, this will be necessary if you want to get the names of siteAttributes.

Get Categories

Replace xxxxxxxxxxxxx with your accessToken, and :organizationId with your organizationId

curl --location --request GET 'https://api.reverscore.net/api/v1/organizations/:organizationId/categories' \
--header 'Authorization: xxxxxxxxxxxxxxx'

HTTP Request

GET https://api.reverscore.net/api/v1/organizations/:organizationId/categories

This will get you the catalog of categories

Response Example ```json [ { "isDefault": false, "isPublic": true, "_id": "5e8f3c90756acc0017f0de08", "name": "waste", "organization": "5c4e8733d36e3e0001562f6a", "id": "5e8f3c90756acc0017f0de08" }, { "isDefault": true, "isPublic": true, "_id": "5e8f3c90756acc0017f0de09", "name": "quality", "organization": "5c4e8733d36e3e0001562f6a", "id": "5e8f3c90756acc0017f0de09" }, ... ]

Schemas

Improvement Idea

{
  "id": "string",
  "name": "string",
  "location": {
    "organization": {
      "id": "string",
      "name": "string"
    },
    "businessUnit": {
      "id": "string",
      "name": "string"
    },
    "country": {
      "id": "string",
      "name": "string"
    },
    "site": {
      "id": "string",
      "name": "string"
    },
    "tags": [
      {
        "id": "string",
        "name": "string",
        "type": "area"
      }
    ]
  },
  "notes": "string",
  "priority": "low",
  "lang": "string",
  "author": "string",
  "team": {
    "owner": {
      "id": "string",
      "displayname": "string",
      "familyname": "string",
      "nickname": "string",
      "employeeId": "string",
      "email": "string",
      "isCoach": true,
      "language": "string",
      "status": "created",
      "createdAt": "2019-08-24T14:15:22Z",
      "isDeleted": true,
      "organization": {
        "id": "string",
        "name": "string"
      },
      "businessUnit": {
        "id": "string",
        "name": "string"
      },
      "country": {
        "id": "string",
        "name": "string"
      },
      "site": {
        "id": "string",
        "name": "string"
      },
      "tags": [
        {
          "id": "string",
          "name": "string",
          "type": "area"
        }
      ]
    },
    "coach": {
      "id": "string",
      "displayname": "string",
      "familyname": "string",
      "nickname": "string",
      "employeeId": "string",
      "email": "string",
      "isCoach": true,
      "language": "string",
      "status": "created",
      "createdAt": "2019-08-24T14:15:22Z",
      "isDeleted": true,
      "organization": {
        "id": "string",
        "name": "string"
      },
      "businessUnit": {
        "id": "string",
        "name": "string"
      },
      "country": {
        "id": "string",
        "name": "string"
      },
      "site": {
        "id": "string",
        "name": "string"
      },
      "tags": [
        {
          "id": "string",
          "name": "string",
          "type": "area"
        }
      ]
    },
    "collaborators": [
      {
        "id": "string",
        "displayname": "string",
        "familyname": "string",
        "nickname": "string",
        "employeeId": "string",
        "email": "string",
        "isCoach": true,
        "language": "string",
        "status": "created",
        "createdAt": "2019-08-24T14:15:22Z",
        "isDeleted": true,
        "organization": {
          "id": "string",
          "name": "string"
        },
        "businessUnit": {
          "id": "string",
          "name": "string"
        },
        "country": {
          "id": "string",
          "name": "string"
        },
        "site": {
          "id": "string",
          "name": "string"
        },
        "tags": [
          {
            "id": "string",
            "name": "string",
            "type": "area"
          }
        ]
      }
    ]
  },
  "categories": [
    "waste"
  ],
  "currencyMetadata": {
    "exchangeRate": "string",
    "currentCurrency": "string",
    "globalCurrency": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "implementedAt": "2019-08-24T14:15:22Z",
  "completedAuthor": "string",
  "suggestedSites": [
    null
  ],
  "isHighlighted": true,
  "implemented": true,
  "hasImplementationValidation": true,
  "hasFinancialValidation": true,
  "points": 0,
  "totalLikes": 0,
  "likedByMe": true,
  "totalComments": 0,
  "totalShares": 0,
  "status": "string",
  "currentPhase": "relate",
  "relate": {
    "problem": "string",
    "idea": "string",
    "expectedResult": "string",
    "media": [
      "string"
    ]
  },
  "experiment": {
    "description": "string",
    "media": [
      "string"
    ]
  },
  "verify": {
    "hasWorked": true,
    "learning": "string"
  },
  "expand": {
    "solution": "string",
    "notImplementedReason": "string",
    "media": [
      "string"
    ]
  },
  "reviewPhase": {
    "costReduction": {},
    "investment": {},
    "revenue": {},
    "timeTracking": {},
    "estimationExplanation": "string"
  }
}

Properties

Name Type Description
id string none
name string none
location location none
notes string none
priority string none
lang string none
author string Author's account id
team rev-team none
categories [category] none
currencyMetadata currency-metadata none
createdAt string(date-time) none
updatedAt string(date-time) none
completedAt string(date-time) none
implementedAt string(date-time) none
completedAuthor string Account Id of the person that completed the Improvement Idea
suggestedSites [any] List of Site Id's where this Improvement Idea could be implemented.
isHighlighted boolean none
implemented boolean none
hasImplementationValidation boolean none
hasFinancialValidation boolean none
points integer none
totalLikes integer none
likedByMe boolean none
totalComments integer none
totalShares integer none
status string none
currentPhase string none
relate object none
» problem string none
» idea string none
» expectedResult string none
» media [string] none
experiment object none
» description string none
» media [string] none
verify object none
» hasWorked boolean none
» learning string none
expand object none
» solution string none
» notImplementedReason string none
» media [string] none
reviewPhase object none
» costReduction object none
» investment object none
» revenue object none
» timeTracking object none
» estimationExplanation string Text to justify provided values for validations.

Enumerated Values

Property Value
priority low
priority medium
priority high
currentPhase relate
currentPhase experiment
currentPhase verify
currentPhase expand
currentPhase review

Quick Action

{
  "id": "string",
  "name": "string",
  "location": {
    "organization": {
      "id": "string",
      "name": "string"
    },
    "businessUnit": {
      "id": "string",
      "name": "string"
    },
    "country": {
      "id": "string",
      "name": "string"
    },
    "site": {
      "id": "string",
      "name": "string"
    },
    "tags": [
      {
        "id": "string",
        "name": "string",
        "type": "area"
      }
    ]
  },
  "notes": "string",
  "priority": "low",
  "lang": "string",
  "author": "string",
  "team": {
    "owner": {
      "id": "string",
      "displayname": "string",
      "familyname": "string",
      "nickname": "string",
      "employeeId": "string",
      "email": "string",
      "isCoach": true,
      "language": "string",
      "status": "created",
      "createdAt": "2019-08-24T14:15:22Z",
      "isDeleted": true,
      "organization": {
        "id": "string",
        "name": "string"
      },
      "businessUnit": {
        "id": "string",
        "name": "string"
      },
      "country": {
        "id": "string",
        "name": "string"
      },
      "site": {
        "id": "string",
        "name": "string"
      },
      "tags": [
        {
          "id": "string",
          "name": "string",
          "type": "area"
        }
      ]
    },
    "coach": {
      "id": "string",
      "displayname": "string",
      "familyname": "string",
      "nickname": "string",
      "employeeId": "string",
      "email": "string",
      "isCoach": true,
      "language": "string",
      "status": "created",
      "createdAt": "2019-08-24T14:15:22Z",
      "isDeleted": true,
      "organization": {
        "id": "string",
        "name": "string"
      },
      "businessUnit": {
        "id": "string",
        "name": "string"
      },
      "country": {
        "id": "string",
        "name": "string"
      },
      "site": {
        "id": "string",
        "name": "string"
      },
      "tags": [
        {
          "id": "string",
          "name": "string",
          "type": "area"
        }
      ]
    },
    "collaborators": [
      {
        "id": "string",
        "displayname": "string",
        "familyname": "string",
        "nickname": "string",
        "employeeId": "string",
        "email": "string",
        "isCoach": true,
        "language": "string",
        "status": "created",
        "createdAt": "2019-08-24T14:15:22Z",
        "isDeleted": true,
        "organization": {
          "id": "string",
          "name": "string"
        },
        "businessUnit": {
          "id": "string",
          "name": "string"
        },
        "country": {
          "id": "string",
          "name": "string"
        },
        "site": {
          "id": "string",
          "name": "string"
        },
        "tags": [
          {
            "id": "string",
            "name": "string",
            "type": "area"
          }
        ]
      }
    ]
  },
  "categories": [
    "waste"
  ],
  "currencyMetadata": {
    "exchangeRate": "string",
    "currentCurrency": "string",
    "globalCurrency": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "completedAuthor": "string",
  "suggestedSites": [
    null
  ],
  "isHighlighted": true,
  "points": 0,
  "likedByMe": true,
  "totalLikes": 0,
  "totalShares": 0,
  "totalComments": 0,
  "status": "string",
  "currentPhase": "before",
  "beforePhase": {
    "situation": "string",
    "media": [
      "string"
    ],
    "situationTypes": [
      "sort"
    ]
  },
  "afterPhase": {
    "solution": "string",
    "media": [
      "string"
    ],
    "suggestedTags": [
      "string"
    ]
  },
  "reviewPhase": {
    "costReduction": {},
    "investment": {},
    "revenue": {},
    "timeTracking": {},
    "estimationExplanation": "string"
  }
}

Properties

Name Type Description
id string none
name string none
location location none
notes string none
priority string none
lang string none
author string Author's account id
team rev-team none
categories [category] none
currencyMetadata currency-metadata none
createdAt string(date-time) none
updatedAt string(date-time) none
completedAt string(date-time) none
completedAuthor string Account Id of the person that completed the Quick Action
suggestedSites [any] Site Ids where this Quick Action could be implemented.
isHighlighted boolean none
points integer none
likedByMe boolean none
totalLikes integer none
totalShares integer none
totalComments integer none
status string none
currentPhase string none
beforePhase object none
» situation string Custom description of the situation.
» media [string] URLs of media elements used as evidence of this phase.
» situationTypes [situation-type] List of common situations provided by Rever to be used as tags for this Rev.
afterPhase object none
» solution string Applied solution for this situation
» media [string] URLs of media elements used as evidence of this phase.
» suggestedTags [string] List of Rev tags that could be used as hint to suggest this solution.
reviewPhase object none
» costReduction object none
» investment object none
» revenue object none
» timeTracking object none
» estimationExplanation string Text to justify provided values for validations.

Enumerated Values

Property Value
priority low
priority medium
priority high
currentPhase before
currentPhase after
currentPhase review

Problem Solving

{
  "id": "string",
  "name": "string",
  "location": {
    "organization": {
      "id": "string",
      "name": "string"
    },
    "businessUnit": {
      "id": "string",
      "name": "string"
    },
    "country": {
      "id": "string",
      "name": "string"
    },
    "site": {
      "id": "string",
      "name": "string"
    },
    "tags": [
      {
        "id": "string",
        "name": "string",
        "type": "area"
      }
    ]
  },
  "notes": "string",
  "priority": "low",
  "lang": "string",
  "author": "string",
  "team": {
    "owner": {
      "id": "string",
      "displayname": "string",
      "familyname": "string",
      "nickname": "string",
      "employeeId": "string",
      "email": "string",
      "isCoach": true,
      "language": "string",
      "status": "created",
      "createdAt": "2019-08-24T14:15:22Z",
      "isDeleted": true,
      "organization": {
        "id": "string",
        "name": "string"
      },
      "businessUnit": {
        "id": "string",
        "name": "string"
      },
      "country": {
        "id": "string",
        "name": "string"
      },
      "site": {
        "id": "string",
        "name": "string"
      },
      "tags": [
        {
          "id": "string",
          "name": "string",
          "type": "area"
        }
      ]
    },
    "coach": {
      "id": "string",
      "displayname": "string",
      "familyname": "string",
      "nickname": "string",
      "employeeId": "string",
      "email": "string",
      "isCoach": true,
      "language": "string",
      "status": "created",
      "createdAt": "2019-08-24T14:15:22Z",
      "isDeleted": true,
      "organization": {
        "id": "string",
        "name": "string"
      },
      "businessUnit": {
        "id": "string",
        "name": "string"
      },
      "country": {
        "id": "string",
        "name": "string"
      },
      "site": {
        "id": "string",
        "name": "string"
      },
      "tags": [
        {
          "id": "string",
          "name": "string",
          "type": "area"
        }
      ]
    },
    "collaborators": [
      {
        "id": "string",
        "displayname": "string",
        "familyname": "string",
        "nickname": "string",
        "employeeId": "string",
        "email": "string",
        "isCoach": true,
        "language": "string",
        "status": "created",
        "createdAt": "2019-08-24T14:15:22Z",
        "isDeleted": true,
        "organization": {
          "id": "string",
          "name": "string"
        },
        "businessUnit": {
          "id": "string",
          "name": "string"
        },
        "country": {
          "id": "string",
          "name": "string"
        },
        "site": {
          "id": "string",
          "name": "string"
        },
        "tags": [
          {
            "id": "string",
            "name": "string",
            "type": "area"
          }
        ]
      }
    ]
  },
  "categories": [
    "waste"
  ],
  "currencyMetadata": {
    "exchangeRate": "string",
    "currentCurrency": "string",
    "globalCurrency": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "completedAuthor": "string",
  "suggestedSites": [
    null
  ],
  "isHighlighted": true,
  "totalLikes": 0,
  "likedByMe": true,
  "totalComments": 0,
  "totalShares": 0,
  "status": "string",
  "currentPhase": "analysis",
  "problemAnalysis": {
    "problem": "string",
    "problemMedia": [
      "string"
    ],
    "containment": "string",
    "goals": "string",
    "countermeasuresMedia": [
      "string"
    ],
    "rootCauseMedia": [
      "string"
    ],
    "countermeasuresApproach": "containment",
    "countermeasuresDescription": "string",
    "rootCauses": [
      {
        "name": "string",
        "type": "method",
        "description": "string",
        "correctiveAction": "string",
        "correctiveActionWorked": true,
        "correctiveLearning": "string",
        "correctiveActionMedia": [
          "string"
        ],
        "preventiveAction": "string"
      }
    ]
  }
}

Properties

Name Type Description
id string none
name string none
location location none
notes string none
priority string none
lang string none
author string Author's account id
team rev-team none
categories [category] none
currencyMetadata currency-metadata none
createdAt string(date-time) none
updatedAt string(date-time) none
completedAt string(date-time) none
completedAuthor string Account Id of the person that completed the Improvement Idea
suggestedSites [any] List of Site Id's where this Improvement Idea could be implemented.
isHighlighted boolean none
totalLikes integer none
likedByMe boolean none
totalComments integer none
totalShares integer none
status string none
currentPhase string none
problemAnalysis object none
» problem string none
» problemMedia [string] none
» containment string none
» goals string none
» countermeasuresMedia [string] none
» rootCauseMedia [string] none
» countermeasuresApproach string none
» countermeasuresDescription string none
» rootCauses [object] none
»» name string none
»» type string none
»» description string none
»» correctiveAction string none
»» correctiveActionWorked boolean none
»» correctiveLearning string none
»» correctiveActionMedia [string] none
»» preventiveAction string none

Enumerated Values

Property Value
priority low
priority medium
priority high
currentPhase analysis
currentPhase solutions
currentPhase review
countermeasuresApproach containment
countermeasuresApproach goals
type method
type machine
type man
type material
type medium
type other

Challenge

{
  "id": "string",
  "name": "string",
  "description": "string",
  "KPIs": "string",
  "rewardsText": "string",
  "organization": {
    "id": "string",
    "name": "string"
  },
  "businessUnits": [
    null
  ],
  "countries": [
    null
  ],
  "sites": [
    null
  ],
  "tags": {
    "id": "string",
    "name": "string",
    "type": "area"
  },
  "categories": [
    "waste"
  ],
  "owner": {
    "id": "string",
    "displayname": "string",
    "familyname": "string",
    "nickname": "string",
    "employeeId": "string",
    "email": "string",
    "isCoach": true,
    "language": "string",
    "status": "created",
    "createdAt": "2019-08-24T14:15:22Z",
    "isDeleted": true,
    "organization": {
      "id": "string",
      "name": "string"
    },
    "businessUnit": {
      "id": "string",
      "name": "string"
    },
    "country": {
      "id": "string",
      "name": "string"
    },
    "site": {
      "id": "string",
      "name": "string"
    },
    "tags": [
      {
        "id": "string",
        "name": "string",
        "type": "area"
      }
    ]
  },
  "totalRevs": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "startAt": "2019-08-24T14:15:22Z",
  "endAt": "2019-08-24T14:15:22Z"
}

Properties

Name Type Description
id string none
name string none
description string none
KPIs string none
rewardsText string none
organization location-level none
businessUnits [any] The business units where this Challenge will apply
countries [any] The countries where this Challenge will apply
sites [any] The sites where this Challenge will apply
tags tag none
categories [category] none
owner account none
totalRevs integer Total Revs linked to this Challenge
createdAt string(date-time) none
updatedAt string(date-time) none
startAt string(date-time) none
endAt string(date-time) none

Location

{
  "organization": {
    "id": "string",
    "name": "string"
  },
  "businessUnit": {
    "id": "string",
    "name": "string"
  },
  "country": {
    "id": "string",
    "name": "string"
  },
  "site": {
    "id": "string",
    "name": "string"
  },
  "tags": [
    {
      "id": "string",
      "name": "string",
      "type": "area"
    }
  ]
}

Properties

Name Type Description
organization location-level none
businessUnit location-level none
country location-level none
site location-level none
tags [tag] none

Location level

{
  "id": "string",
  "name": "string"
}

Properties

Name Type Description
id string none
name string none

Tag

{
  "id": "string",
  "name": "string",
  "type": "area"
}

Properties

Name Type Description
id string none
name string none
type string none

Enumerated Values

Property Value
type area
type product
type other

Account

{
  "id": "string",
  "displayname": "string",
  "familyname": "string",
  "nickname": "string",
  "employeeId": "string",
  "email": "string",
  "isCoach": true,
  "language": "string",
  "status": "created",
  "createdAt": "2019-08-24T14:15:22Z",
  "isDeleted": true,
  "organization": {
    "id": "string",
    "name": "string"
  },
  "businessUnit": {
    "id": "string",
    "name": "string"
  },
  "country": {
    "id": "string",
    "name": "string"
  },
  "site": {
    "id": "string",
    "name": "string"
  },
  "tags": [
    {
      "id": "string",
      "name": "string",
      "type": "area"
    }
  ]
}

Properties

Name Type Description
id string none
displayname string none
familyname string none
nickname string none
employeeId string none
email string none
isCoach boolean none
language string none
status string none
createdAt string(date-time) none
isDeleted boolean none
organization location-level none
businessUnit location-level none
country location-level none
site location-level none
tags [tag] none

Enumerated Values

Property Value
status created
status pending
status joined

Rev Team

{
  "owner": {
    "id": "string",
    "displayname": "string",
    "familyname": "string",
    "nickname": "string",
    "employeeId": "string",
    "email": "string",
    "isCoach": true,
    "language": "string",
    "status": "created",
    "createdAt": "2019-08-24T14:15:22Z",
    "isDeleted": true,
    "organization": {
      "id": "string",
      "name": "string"
    },
    "businessUnit": {
      "id": "string",
      "name": "string"
    },
    "country": {
      "id": "string",
      "name": "string"
    },
    "site": {
      "id": "string",
      "name": "string"
    },
    "tags": [
      {
        "id": "string",
        "name": "string",
        "type": "area"
      }
    ]
  },
  "coach": {
    "id": "string",
    "displayname": "string",
    "familyname": "string",
    "nickname": "string",
    "employeeId": "string",
    "email": "string",
    "isCoach": true,
    "language": "string",
    "status": "created",
    "createdAt": "2019-08-24T14:15:22Z",
    "isDeleted": true,
    "organization": {
      "id": "string",
      "name": "string"
    },
    "businessUnit": {
      "id": "string",
      "name": "string"
    },
    "country": {
      "id": "string",
      "name": "string"
    },
    "site": {
      "id": "string",
      "name": "string"
    },
    "tags": [
      {
        "id": "string",
        "name": "string",
        "type": "area"
      }
    ]
  },
  "collaborators": [
    {
      "id": "string",
      "displayname": "string",
      "familyname": "string",
      "nickname": "string",
      "employeeId": "string",
      "email": "string",
      "isCoach": true,
      "language": "string",
      "status": "created",
      "createdAt": "2019-08-24T14:15:22Z",
      "isDeleted": true,
      "organization": {
        "id": "string",
        "name": "string"
      },
      "businessUnit": {
        "id": "string",
        "name": "string"
      },
      "country": {
        "id": "string",
        "name": "string"
      },
      "site": {
        "id": "string",
        "name": "string"
      },
      "tags": [
        {
          "id": "string",
          "name": "string",
          "type": "area"
        }
      ]
    }
  ]
}

Properties

Name Type Description
owner account none
coach account none
collaborators [account] none

Currency Metadata

{
  "exchangeRate": "string",
  "currentCurrency": "string",
  "globalCurrency": "string"
}

Properties

Name Type Description
exchangeRate string none
currentCurrency string none
globalCurrency string none

Category

"waste"

Properties

Name Type Description
Category string none

Enumerated Values

Property Value
Category waste
Category quality
Category cost
Category efficiency_or_time
Category work_environment
Category employee_engagement
Category health_and_safety
Category sustainability
Category customer_service
Category revenue_and_sales
Category new_product
Category other

Situation Type

"sort"

Properties

Name Type Description
Situation Type string none

Enumerated Values

Property Value
Situation Type sort
Situation Type set_in_order
Situation Type scrub
Situation Type standardize
Situation Type sustain
Situation Type minor
Situation Type normal
Situation Type critical
Situation Type minor_flaw
Situation Type unfulfilled_basic_condition
Situation Type inaccessible_place
Situation Type contamination_source
Situation Type quality_defect
Situation Type unnecessary_equipment
Situation Type unsafe_place
Situation Type lessons_learned
Situation Type quality_near_miss

undefined