Skip to content

Click in-app to access the full platform documentation for your version of DataRobot.

Use Case

This page outlines the operations, endpoints, parameters, and example requests and responses for the Use Case.

GET /api/v2/useCaseValueTemplates/

List available use cases templates.

Code samples

# You can also use wget
curl -X GET http://10.97.84.40/api/v2/useCaseValueTemplates/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

[
  {
    "description": "string",
    "schema": [
      {
        "parameterName": "string",
        "schema": {
          "elementType": "integer",
          "label": "string",
          "maximum": 0,
          "minimum": 0,
          "placeholder": "string",
          "unit": "string"
        }
      }
    ],
    "templateType": "classification",
    "title": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [UseCaseValueTemplateResponse] false none
» description string true Description of Value Template
» schema [UseCaseValueTemplateParameterWithSchema] true Schema definition of all template parameters
»» parameterName string true Name of the parameter
»» schema UseCaseValueTemplateSchema true none
»»» elementType string true Possible types used for template variables
»»» label string true Label describing the represented value
»»» maximum integer¦null true Sets Maximum value if given
»»» minimum integer¦null true Sets Minimum value if given
»»» placeholder string true Text that can be used to prefill an input filed for the value
»»» unit string¦null true Unit type. e.g. %
» templateType string true The name of the use case value template to be retrieved
» title string true Title of Value Template

Enumerated Values

Property Value
elementType integer
elementType float
elementType number
templateType classification
templateType regression

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/useCaseValueTemplates/{templateType}/

Get an individual use case value template by its name.

Code samples

# You can also use wget
curl -X GET http://10.97.84.40/api/v2/useCaseValueTemplates/{templateType}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
templateType path string true The name of the use case value template to be retrieved

Enumerated Values

Parameter Value
templateType classification
templateType regression

Example responses

200 Response

{
  "description": "string",
  "schema": [
    {
      "parameterName": "string",
      "schema": {
        "elementType": "integer",
        "label": "string",
        "maximum": 0,
        "minimum": 0,
        "placeholder": "string",
        "unit": "string"
      }
    }
  ],
  "templateType": "classification",
  "title": "string"
}

Responses

Status Meaning Description Schema
200 OK none UseCaseValueTemplateResponse
400 Bad Request Bad request None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/useCaseValueTemplates/{templateType}/calculation/

Calculate value of template with given template parameters.

Code samples

# You can also use wget
curl -X GET http://10.97.84.40/api/v2/useCaseValueTemplates/{templateType}/calculation/?accuracyImprovement=0&decisionsCount=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
accuracyImprovement query number true Accuracy improvement
decisionsCount query integer true Estimated number of decisions per year
incorrectDecisionsCount query integer false Estimated number of incorrect decisions per year. Required for templateType CLASSIFICATION
incorrectDecisionCost query number false Estimated cost of an individual incorrect decision. Required for templateType CLASSIFICATION
targetValue query number false Target value. Required for templateType REGRESSION
templateType path string true The name of the use case value template to be retrieved

Enumerated Values

Parameter Value
templateType classification
templateType regression

Example responses

200 Response

{
  "averageValuePerDecision": 0,
  "savedAnnually": 0,
  "template": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  }
}

Responses

Status Meaning Description Schema
200 OK none UseCaseValueTemplateCalculateResponse
400 Bad Request Bad request None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/useCases/

List use cases the requesting user has access to.

Code samples

# You can also use wget
curl -X GET http://10.97.84.40/api/v2/useCases/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over. Default 0.
limit query integer false The number of records to return in the range from 1 to 100. Default 100.
orderBy query string false Sort the use cases by a field of the use case.
namePart query string false Only return use cases with names that match the given string.
stage query string false Filter results by the current stage of the use cases.

Enumerated Values

Parameter Value
orderBy businessImpact
orderBy -businessImpact
orderBy potentialValue
orderBy -potentialValue
orderBy realizedValue
orderBy -realizedValue
orderBy feasibility
orderBy -feasibility
orderBy stage
orderBy -stage
stage ideation
stage queued
stage dataPrepAndModeling
stage validatingAndDeploying
stage inProduction
stage retired
stage onHold

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "accuracyHealth": "string",
      "businessImpact": 1,
      "commentId": "string",
      "content": "string",
      "description": "string",
      "feasibility": 1,
      "id": "string",
      "inProductionWarning": "string",
      "mentions": [
        {
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "username": "string"
        }
      ],
      "modelHealth": "string",
      "name": "string",
      "notes": "string",
      "owner": {
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "username": "string"
      },
      "permissions": [
        "string"
      ],
      "potentialValue": {
        "currency": "BRL",
        "details": "string",
        "value": 0
      },
      "potentialValueTemplate": {
        "data": {
          "accuracyImprovement": 0,
          "decisionsCount": 0,
          "incorrectDecisionCost": 0,
          "incorrectDecisionsCount": 0
        },
        "templateType": "classification"
      },
      "predictionTargets": [
        "string"
      ],
      "predictionsCount": "string",
      "realizedValue": "string",
      "serviceHealth": "string",
      "stage": "ideation",
      "targetDates": [
        {
          "date": "2019-08-24T14:15:22Z",
          "stage": "ideation"
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCaseListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/useCases/

Create a new use case.

Code samples

# You can also use wget
curl -X POST http://10.97.84.40/api/v2/useCases/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "realizedValue": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Parameters

Name In Type Required Description
body body UseCase false none

Example responses

200 Response

{
  "accuracyHealth": "string",
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "inProductionWarning": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "modelHealth": "string",
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "predictionsCount": "string",
  "realizedValue": "string",
  "serviceHealth": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none UseCaseCreateResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/useCases/{useCaseId}/

Delete a use case

Code samples

# You can also use wget
curl -X DELETE http://10.97.84.40/api/v2/useCases/{useCaseId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
useCaseId path string true The id of the use case

Responses

Status Meaning Description Schema
200 OK none None
204 No Content The use case was deleted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/useCases/{useCaseId}/

Retrieve a use case.

Code samples

# You can also use wget
curl -X GET http://10.97.84.40/api/v2/useCases/{useCaseId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
useCaseId path string true The id of the use case

Example responses

200 Response

{
  "accuracyHealth": "string",
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "inProductionWarning": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "modelHealth": "string",
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "predictionsCount": "string",
  "realizedValue": "string",
  "serviceHealth": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none UseCaseResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/useCases/{useCaseId}/

Update a use case.

Code samples

# You can also use wget
curl -X PATCH http://10.97.84.40/api/v2/useCases/{useCaseId}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "businessImpact": 1,
  "description": "string",
  "feasibility": 1,
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "realizedValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Parameters

Name In Type Required Description
useCaseId path string true The id of the use case
body body UseCaseUpdate false none

Example responses

200 Response

{
  "accuracyHealth": "string",
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "inProductionWarning": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "modelHealth": "string",
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "predictionsCount": "string",
  "realizedValue": "string",
  "serviceHealth": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none UseCaseResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/useCases/{useCaseId}/activities/

Retrieve the activities of a use case.

Code samples

# You can also use wget
curl -X GET http://10.97.84.40/api/v2/useCases/{useCaseId}/activities/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over. Default 0.
limit query integer false The number of records to return in the range from 1 to 100. Default 100.
useCaseId path string true The id of the use case

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "eventDescription": {
        "businessImpact": 1,
        "commentId": "string",
        "content": "string",
        "description": "string",
        "feasibility": 1,
        "id": "string",
        "mentions": [
          {
            "firstName": "string",
            "id": "string",
            "lastName": "string",
            "username": "string"
          }
        ],
        "name": "string",
        "notes": "string",
        "owner": {
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "username": "string"
        },
        "permissions": [
          "string"
        ],
        "potentialValue": {
          "currency": "BRL",
          "details": "string",
          "value": 0
        },
        "potentialValueTemplate": {
          "data": {
            "accuracyImprovement": 0,
            "decisionsCount": 0,
            "incorrectDecisionCost": 0,
            "incorrectDecisionsCount": 0
          },
          "templateType": "classification"
        },
        "predictionTargets": [
          "string"
        ],
        "realizedValue": "string",
        "stage": "ideation",
        "targetDates": [
          {
            "date": "2019-08-24T14:15:22Z",
            "stage": "ideation"
          }
        ]
      },
      "eventType": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "user": {
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "username": "string"
      },
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCaseActivityListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/useCases/{useCaseId}/attachments/

Get a list of resources attached to this use case.

Code samples

# You can also use wget
curl -X GET http://10.97.84.40/api/v2/useCases/{useCaseId}/attachments/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped
limit query integer false This many results are returned
type query string false Use case attachment type
useCaseId path string true The id of the use case

Enumerated Values

Parameter Value
type dataset
type modelingProject
type deployment
type customModel
type modelPackage
type application

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "attachedObjectId": "string",
      "canView": true,
      "id": "string",
      "isAccessRequested": true,
      "overview": {
        "accuracyHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        },
        "modelHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        },
        "name": "string",
        "predictionServer": "string",
        "predictionUsage": {
          "dailyRates": [
            0
          ],
          "lastTimestamp": "2019-08-24T14:15:22Z"
        },
        "serviceHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        }
      },
      "type": "dataset",
      "useCaseId": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCaseAttachmentListResponse
404 Not Found Either the use case does not exist or the user does not have permissions to view this use case. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/useCases/{useCaseId}/attachments/

Attach a list of resources to this use case.

Code samples

# You can also use wget
curl -X POST http://10.97.84.40/api/v2/useCases/{useCaseId}/attachments/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "attachedObjects": [
    {
      "attachedObjectId": "string",
      "type": "dataset"
    }
  ]
}

Parameters

Name In Type Required Description
useCaseId path string true The id of the use case
body body CreateUseCaseAttachment false none

Example responses

201 Response

[
  {
    "attachedObjectId": "string",
    "type": "dataset"
  }
]

Responses

Status Meaning Description Schema
201 Created none Inline
404 Not Found Use case or object not found or Use case not writable or object not readable. None
422 Unprocessable Entity The request was formatted improperly None

Response Schema

Status Code 201

Name Type Required Restrictions Description
anonymous [UseCaseAttachment] false none
» attachedObjectId string true The id of the attached object
» type string true Use case attachment type

Enumerated Values

Property Value
type dataset
type modelingProject
type deployment
type customModel
type modelPackage
type application

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/useCases/{useCaseId}/attachments/{attachmentId}/

Removes a resource from a use case.

Code samples

# You can also use wget
curl -X DELETE http://10.97.84.40/api/v2/useCases/{useCaseId}/attachments/{attachmentId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
useCaseId path string true The id of the use case
attachmentId path string true The id of the attachment

Responses

Status Meaning Description Schema
204 No Content none None
403 Forbidden The user does not have permission to remove objects from this use case None
404 Not Found Either the use case does not exist or the user does not have permissions to view this use case. None
422 Unprocessable Entity The request was formatted improperly, or the requested object to delete was not found None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/useCases/{useCaseId}/attachments/{attachmentId}/

Get a resource that is attached to a use case.

Code samples

# You can also use wget
curl -X GET http://10.97.84.40/api/v2/useCases/{useCaseId}/attachments/{attachmentId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
useCaseId path string true The id of the use case
attachmentId path string true The id of the attachment

Example responses

200 Response

{
  "attachedObjectId": "string",
  "canView": true,
  "id": "string",
  "isAccessRequested": true,
  "overview": {
    "accuracyHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    },
    "modelHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    },
    "name": "string",
    "predictionServer": "string",
    "predictionUsage": {
      "dailyRates": [
        0
      ],
      "lastTimestamp": "2019-08-24T14:15:22Z"
    },
    "serviceHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    }
  },
  "type": "dataset",
  "useCaseId": "string"
}

Responses

Status Meaning Description Schema
200 OK none UseCaseAttachmentResponse
403 Forbidden The user does not have permission to attach objects to this use case None
404 Not Found Either the use case does not exist or the user does not have permissions to view this use case. None
422 Unprocessable Entity The request was formatted improperly, or the requested object to attach was not found None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/useCases/{useCaseId}/realizedValueOverTime/

Retrieve realized value information for a given use case over a period of time

Code samples

# You can also use wget
curl -X GET http://10.97.84.40/api/v2/useCases/{useCaseId}/realizedValueOverTime/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
start query string(date-time) false RFC3339 datetime. Start of time period to retrieve the features drift for. If not set, defaults to 1 week from the end of the period.Note: this field only accepts top of the hour RFC3339 datetime strings For example: 2019-08-01T00:00:00Z.
end query string(date-time) false RFC3339 datetime. End of time period to retrieve the features drift for. If not set, defaults to the next top of the hour from now.Note: this field only accepts top of the hour RFC3339 datetime strings For example: 2019-08-01T00:00:00Z.
bucketSize query string(duration) false The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time.
useCaseId path string true The ID of the use case

Example responses

200 Response

{
  "buckets": [
    {
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "predictionsCount": 0,
      "realizedValue": 0
    }
  ],
  "previousTimeRangeSummary": {
    "averagePredictionsCount": 0,
    "averageRealizedValue": 0,
    "period": {
      "end": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z"
    },
    "totalPredictionsCount": 0,
    "totalRealizedValue": 0
  },
  "summary": {
    "averagePredictionsCount": 0,
    "averageRealizedValue": 0,
    "period": {
      "end": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z"
    },
    "totalPredictionsCount": 0,
    "totalRealizedValue": 0
  }
}

Responses

Status Meaning Description Schema
200 OK none UseCaseRealizedValuesOverTimeResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/useCases/{useCaseId}/sharedRoles/

Get a list of users, groups and organizations that have an access to this use case

Code samples

# You can also use wget
curl -X GET http://10.97.84.40/api/v2/useCases/{useCaseId}/sharedRoles/?offset=0&limit=10 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
id query string false Only return roles for a user, group or organization with this identifier.
offset query integer true This many results will be skipped
limit query integer true At most this many results are returned
name query string false Only return roles for a user, group or organization with this name.
shareRecipientType query string false List access controls for recipients with this type.
useCaseId path string true The ID of the use case

Enumerated Values

Parameter Value
shareRecipientType user
shareRecipientType group
shareRecipientType organization

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "OWNER",
      "shareRecipientType": "user"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none UseCaseSharingListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/useCases/{useCaseId}/sharedRoles/

Share a use case with a user, group or organization.

Code samples

# You can also use wget
curl -X PATCH http://10.97.84.40/api/v2/useCases/{useCaseId}/sharedRoles/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "operation": "updateRoles",
  "roles": [
    {
      "id": "string",
      "role": "OWNER",
      "shareRecipientType": "user",
      "username": "string"
    }
  ]
}

Parameters

Name In Type Required Description
useCaseId path string true The ID of the use case
body body UseCaseSharingUpdate false none

Responses

Status Meaning Description Schema
200 OK none None
204 No Content The roles updated successfully None
422 Unprocessable Entity The request was formatted improperly None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

CreateUseCaseAttachment

{
  "attachedObjects": [
    {
      "attachedObjectId": "string",
      "type": "dataset"
    }
  ]
}

Properties

Name Type Required Restrictions Description
attachedObjects [UseCaseAttachment] true An array of attachment objects

DrUserId

{
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
firstName string¦null false First name of use case owner
id string true The DR user ID
lastName string¦null false Last of use case owner
username string false Username of use case owner

EventDescriptions

{
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "realizedValue": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Properties

Name Type Required Restrictions Description
businessImpact integer¦null false maximum: 5
minimum: 1
Expected effects on overall business operations
commentId string false The id for this comment
content string false A string
description string¦null false Use case description
feasibility integer¦null false maximum: 5
minimum: 1
Assessment of how the use case can be accomplished across multiple dimensions
id string¦null false The id of this description item
mentions [DrUserId] false A list of user objects
name string¦null false The name of this event item
notes string¦null false User notes
owner DrUserId false User case owner
permissions [string]¦null false Permissions of current user
potentialValue MonetaryValue false Optional, Contains MonetaryValue objects
potentialValueTemplate any false Optional, Contains Template type and parameter information

anyOf

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateClassification false none

or

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateRegression false none

continued

Name Type Required Restrictions Description
predictionTargets [string] false An array of strings prediction target names
realizedValue any false Optional, Contains MonetaryValue objects

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous MonetaryValue false none

continued

Name Type Required Restrictions Description
stage string false Current stage of use case
targetDates [TargetDate]¦null false Array of TargetDate objects

Enumerated Values

Property Value
stage ideation
stage queued
stage dataPrepAndModeling
stage validatingAndDeploying
stage inProduction
stage retired
stage onHold

MonetaryValue

{
  "currency": "BRL",
  "details": "string",
  "value": 0
}

Properties

Name Type Required Restrictions Description
currency string true ISO code of currency
details string¦null false Optional user notes
value number true Amount of value

Enumerated Values

Property Value
currency BRL
currency EUR
currency GBP
currency JPY
currency KRW
currency UAH
currency USD

SharingListData

{
  "id": "string",
  "name": "string",
  "role": "OWNER",
  "shareRecipientType": "user"
}

Properties

Name Type Required Restrictions Description
id string true The ID of the recipient
name string false The name of the user, group, or organization
role string true The assigned role
shareRecipientType string true The recipient type

Enumerated Values

Property Value
role OWNER
role USER
role CONSUMER
role NO_ROLE
shareRecipientType user
shareRecipientType group
shareRecipientType organization

SharingRoleUpdateData

{
  "id": "string",
  "role": "OWNER",
  "shareRecipientType": "user",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
id string false The ID of the recipient
role string true The assigned role
shareRecipientType string true The recipient type
username string false The name of the user, group, or organization

Enumerated Values

Property Value
role OWNER
role USER
role CONSUMER
role NO_ROLE
shareRecipientType user
shareRecipientType group
shareRecipientType organization

TargetDate

{
  "date": "2019-08-24T14:15:22Z",
  "stage": "ideation"
}

Properties

Name Type Required Restrictions Description
date string(date-time) true Date of the target
stage string true Name of the target stage

Enumerated Values

Property Value
stage ideation
stage queued
stage dataPrepAndModeling
stage validatingAndDeploying
stage inProduction
stage retired
stage onHold

UseCase

{
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "realizedValue": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Properties

Name Type Required Restrictions Description
businessImpact integer¦null false maximum: 5
minimum: 1
Expected effects on overall business operations
commentId string false The id for this comment
content string false A string
description string false maxLength: 1024
Use case description
feasibility integer¦null false maximum: 5
minimum: 1
Assessment of how the use case can be accomplished across multiple dimensions
id string¦null false The id of this description item
mentions [DrUserId] false A list of user objects
name string true maxLength: 512
Name of the use case
notes string¦null false User notes
owner DrUserId false User case owner
permissions [string]¦null false Permissions of current user
potentialValue MonetaryValue false Optional, Contains MonetaryValue objects
potentialValueTemplate any false Optional, Contains Template type and parameter information

anyOf

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateClassification false none

or

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateRegression false none

continued

Name Type Required Restrictions Description
predictionTargets [string] false An array of strings prediction target names
realizedValue any false Optional, Contains MonetaryValue objects

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous MonetaryValue false none

continued

Name Type Required Restrictions Description
stage string false Current stage of use case
targetDates [TargetDate] false Array of TargetDate objects

Enumerated Values

Property Value
stage ideation
stage queued
stage dataPrepAndModeling
stage validatingAndDeploying
stage inProduction
stage retired
stage onHold

UseCaseActivity

{
  "eventDescription": {
    "businessImpact": 1,
    "commentId": "string",
    "content": "string",
    "description": "string",
    "feasibility": 1,
    "id": "string",
    "mentions": [
      {
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "username": "string"
      }
    ],
    "name": "string",
    "notes": "string",
    "owner": {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    },
    "permissions": [
      "string"
    ],
    "potentialValue": {
      "currency": "BRL",
      "details": "string",
      "value": 0
    },
    "potentialValueTemplate": {
      "data": {
        "accuracyImprovement": 0,
        "decisionsCount": 0,
        "incorrectDecisionCost": 0,
        "incorrectDecisionsCount": 0
      },
      "templateType": "classification"
    },
    "predictionTargets": [
      "string"
    ],
    "realizedValue": "string",
    "stage": "ideation",
    "targetDates": [
      {
        "date": "2019-08-24T14:15:22Z",
        "stage": "ideation"
      }
    ]
  },
  "eventType": "string",
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "user": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "username": "string"
}

Properties

Name Type Required Restrictions Description
eventDescription EventDescriptions true Details of the activity, content depends on activity type
eventType string¦null true The type of activity
firstName string¦null false First name of use case owner
id string false The id of the use case activity
lastName string¦null false Last of use case owner
timestamp string(date-time) true The timestamp of the activity
user DrUserId true Information about the user the initiated the event
username string false Username of use case owner

UseCaseActivityListResponse

{
  "count": 0,
  "data": [
    {
      "eventDescription": {
        "businessImpact": 1,
        "commentId": "string",
        "content": "string",
        "description": "string",
        "feasibility": 1,
        "id": "string",
        "mentions": [
          {
            "firstName": "string",
            "id": "string",
            "lastName": "string",
            "username": "string"
          }
        ],
        "name": "string",
        "notes": "string",
        "owner": {
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "username": "string"
        },
        "permissions": [
          "string"
        ],
        "potentialValue": {
          "currency": "BRL",
          "details": "string",
          "value": 0
        },
        "potentialValueTemplate": {
          "data": {
            "accuracyImprovement": 0,
            "decisionsCount": 0,
            "incorrectDecisionCost": 0,
            "incorrectDecisionsCount": 0
          },
          "templateType": "classification"
        },
        "predictionTargets": [
          "string"
        ],
        "realizedValue": "string",
        "stage": "ideation",
        "targetDates": [
          {
            "date": "2019-08-24T14:15:22Z",
            "stage": "ideation"
          }
        ]
      },
      "eventType": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "user": {
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "username": "string"
      },
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true The number of items returned on this page
data [UseCaseActivity] true The activities of a use case
next string(uri)¦null true URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true The number of items matching the query condition

UseCaseAttachment

{
  "attachedObjectId": "string",
  "type": "dataset"
}

Properties

Name Type Required Restrictions Description
attachedObjectId string true The id of the attached object
type string true Use case attachment type

Enumerated Values

Property Value
type dataset
type modelingProject
type deployment
type customModel
type modelPackage
type application

UseCaseAttachmentApplicationOverview

{
  "appType": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastModifiedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "version": "string"
}

Properties

Name Type Required Restrictions Description
appType string true Type of the application
createdAt string(date-time) true Time when application was created
lastModifiedAt string(date-time) true Time of the last modification
name string true Name of the application
version string true Version string of the app

UseCaseAttachmentCustomModelOverview

{
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "owner": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Time when custom model was created
modifiedAt string(date-time) true Time of the last modification
name string true Name of the custom model
owner string true Name of the custom model owner

UseCaseAttachmentDatasetOverview

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "lastModifiedAt": "2019-08-24T14:15:22Z",
  "lastModifiedBy": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Time when dataset was created
createdBy string true Name of user who created the dataset
lastModifiedAt string(date-time) true Time of the last modification
lastModifiedBy string true Name of user who did last modification
name string true Name of the dataset

UseCaseAttachmentDeploymentHealth

{
  "endDate": "2019-08-24T14:15:22Z",
  "message": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "status": "string"
}

Properties

Name Type Required Restrictions Description
endDate string(date-time) true End date of health status
message string true Health status related information
startDate string(date-time) true Start date of health status
status string true Health status

UseCaseAttachmentDeploymentOverview

{
  "accuracyHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "message": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "string"
  },
  "modelHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "message": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "string"
  },
  "name": "string",
  "predictionServer": "string",
  "predictionUsage": {
    "dailyRates": [
      0
    ],
    "lastTimestamp": "2019-08-24T14:15:22Z"
  },
  "serviceHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "message": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "string"
  }
}

Properties

Name Type Required Restrictions Description
accuracyHealth UseCaseAttachmentDeploymentHealth true Accuracy related health status
modelHealth UseCaseAttachmentDeploymentHealth true Model related health status
name string true Name of the deployment
predictionServer string true Name of prediction server
predictionUsage UseCaseAttachmentDeploymentPredictionUsage true Use case attachment detail for Deployment usage
serviceHealth UseCaseAttachmentDeploymentHealth true Service related health status

UseCaseAttachmentDeploymentPredictionUsage

{
  "dailyRates": [
    0
  ],
  "lastTimestamp": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
dailyRates [integer] true List of daily request counts
lastTimestamp string(date-time) true Last prediction time

UseCaseAttachmentListResponse

{
  "count": 0,
  "data": [
    {
      "attachedObjectId": "string",
      "canView": true,
      "id": "string",
      "isAccessRequested": true,
      "overview": {
        "accuracyHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        },
        "modelHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        },
        "name": "string",
        "predictionServer": "string",
        "predictionUsage": {
          "dailyRates": [
            0
          ],
          "lastTimestamp": "2019-08-24T14:15:22Z"
        },
        "serviceHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        }
      },
      "type": "dataset",
      "useCaseId": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true Number of results returned
data [UseCaseAttachmentResponse] true An array of attachment objects
next string¦null true Link to next page
previous string¦null true Link to previous page
totalCount integer true Total number of results available

UseCaseAttachmentModelPackageOverview

{
  "createdAt": "2019-08-24T14:15:22Z",
  "deploymentCount": 0,
  "executionType": "string",
  "name": "string",
  "targetName": "string",
  "targetType": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Time when model package was created
deploymentCount integer true Number of deployments
executionType string true Type of execution
name string true Name of the model package
targetName string true Name of modeling target
targetType string true Type of modeling target

UseCaseAttachmentModelingProjectOverview

{
  "createdAt": "2019-08-24T14:15:22Z",
  "datasetName": "string",
  "name": "string",
  "numberOfModels": 0,
  "owner": "string",
  "targetName": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Time when project was created
datasetName string true Name of default dataset
name string true Name of the project
numberOfModels integer¦null true Number of the models in the project
owner string¦null true Name of the modeling project owner
targetName string true Name of modeling target

UseCaseAttachmentResponse

{
  "attachedObjectId": "string",
  "canView": true,
  "id": "string",
  "isAccessRequested": true,
  "overview": {
    "accuracyHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    },
    "modelHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    },
    "name": "string",
    "predictionServer": "string",
    "predictionUsage": {
      "dailyRates": [
        0
      ],
      "lastTimestamp": "2019-08-24T14:15:22Z"
    },
    "serviceHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    }
  },
  "type": "dataset",
  "useCaseId": "string"
}

Properties

Name Type Required Restrictions Description
attachedObjectId string true The id of the attached object
canView boolean true Indicates if user has view access to the attached object
id string true The id of the use case
isAccessRequested boolean true Indicates if user has requested access to the attached object
overview any true Detailed information depending on the type of the attachment

oneOf

Name Type Required Restrictions Description
» anonymous UseCaseAttachmentDeploymentOverview false none

xor

Name Type Required Restrictions Description
» anonymous UseCaseAttachmentDatasetOverview false none

xor

Name Type Required Restrictions Description
» anonymous UseCaseAttachmentModelingProjectOverview false none

xor

Name Type Required Restrictions Description
» anonymous UseCaseAttachmentCustomModelOverview false none

xor

Name Type Required Restrictions Description
» anonymous UseCaseAttachmentModelPackageOverview false none

xor

Name Type Required Restrictions Description
» anonymous UseCaseAttachmentApplicationOverview false none

continued

Name Type Required Restrictions Description
type string true Use case attachment type
useCaseId string true The id of the use case

Enumerated Values

Property Value
type dataset
type modelingProject
type deployment
type customModel
type modelPackage
type application

UseCaseBucket

{
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "predictionsCount": 0,
  "realizedValue": 0
}

Properties

Name Type Required Restrictions Description
period UseCaseBucketPeriod true A period object describing the time this bucket covers
predictionsCount integer true Total number of predictions that happened in this bucket
realizedValue integer false Total amount of value realised during this bucket

UseCaseBucketPeriod

{
  "end": "2019-08-24T14:15:22Z",
  "start": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
end string(date-time) true RFC3339 datetime. End of time period to retrieve.
start string(date-time) true RFC3339 datetime. Start of time period to retrieve.

UseCaseCreateResponse

{
  "accuracyHealth": "string",
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "inProductionWarning": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "modelHealth": "string",
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "predictionsCount": "string",
  "realizedValue": "string",
  "serviceHealth": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Properties

Name Type Required Restrictions Description
accuracyHealth any false The health of the accuracy

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous UseCaseHealthInformation false none

continued

Name Type Required Restrictions Description
businessImpact integer¦null false maximum: 5
minimum: 1
Expected effects on overall business operations
commentId string false The id for this comment
content string false A string
description string false Use case description
feasibility integer¦null false maximum: 5
minimum: 1
Assessment of how the use case can be accomplished across multiple dimensions
id string false The id of the use case
inProductionWarning string¦null false An optional warning to indicate that deployments are attached to this use case.
mentions [DrUserId] false A list of user objects
modelHealth any false The health of the model

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous UseCaseHealthInformation false none

continued

Name Type Required Restrictions Description
name string false Name of the use case
notes string¦null false User notes
owner DrUserId false User case owner
permissions [string]¦null false Permissions of current user
potentialValue MonetaryValue false Optional, Contains MonetaryValue objects
potentialValueTemplate any false Optional, Contains Template type and parameter information

anyOf

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateClassification false none

or

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateRegression false none

continued

Name Type Required Restrictions Description
predictionTargets [string] false An array of strings prediction target names
predictionsCount any false Count of the number of predictions made.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous [integer]¦null false A list of prediction counts.

continued

Name Type Required Restrictions Description
realizedValue any false Optional, Contains MonetaryValue objects

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous MonetaryValue false none

continued

Name Type Required Restrictions Description
serviceHealth any false The health of the service

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous UseCaseHealthInformation false none

continued

Name Type Required Restrictions Description
stage string false Current stage of use case
targetDates [TargetDate]¦null false Array of TargetDate objects

Enumerated Values

Property Value
stage ideation
stage queued
stage dataPrepAndModeling
stage validatingAndDeploying
stage inProduction
stage retired
stage onHold

UseCaseHealthInformation

{
  "endDate": "2019-08-24T14:15:22Z",
  "message": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "status": "string"
}

Properties

Name Type Required Restrictions Description
endDate string(date-time)¦null true The end date for this health status
message string¦null true Information about the health status
startDate string(date-time)¦null true The start date for this health status
status string¦null true The status of the use case

UseCaseListResponse

{
  "count": 0,
  "data": [
    {
      "accuracyHealth": "string",
      "businessImpact": 1,
      "commentId": "string",
      "content": "string",
      "description": "string",
      "feasibility": 1,
      "id": "string",
      "inProductionWarning": "string",
      "mentions": [
        {
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "username": "string"
        }
      ],
      "modelHealth": "string",
      "name": "string",
      "notes": "string",
      "owner": {
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "username": "string"
      },
      "permissions": [
        "string"
      ],
      "potentialValue": {
        "currency": "BRL",
        "details": "string",
        "value": 0
      },
      "potentialValueTemplate": {
        "data": {
          "accuracyImprovement": 0,
          "decisionsCount": 0,
          "incorrectDecisionCost": 0,
          "incorrectDecisionsCount": 0
        },
        "templateType": "classification"
      },
      "predictionTargets": [
        "string"
      ],
      "predictionsCount": "string",
      "realizedValue": "string",
      "serviceHealth": "string",
      "stage": "ideation",
      "targetDates": [
        {
          "date": "2019-08-24T14:15:22Z",
          "stage": "ideation"
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true The number of items returned on this page
data [UseCaseResponse] true A list of the use cases that match the query
next string(uri)¦null true URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true The number of items matching the query condition

UseCaseRealizedValuesOverTimeResponse

{
  "buckets": [
    {
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "predictionsCount": 0,
      "realizedValue": 0
    }
  ],
  "previousTimeRangeSummary": {
    "averagePredictionsCount": 0,
    "averageRealizedValue": 0,
    "period": {
      "end": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z"
    },
    "totalPredictionsCount": 0,
    "totalRealizedValue": 0
  },
  "summary": {
    "averagePredictionsCount": 0,
    "averageRealizedValue": 0,
    "period": {
      "end": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z"
    },
    "totalPredictionsCount": 0,
    "totalRealizedValue": 0
  }
}

Properties

Name Type Required Restrictions Description
buckets [UseCaseBucket] true An array of bucket objects representing prediction totals and realized value over time
previousTimeRangeSummary UseCaseSummary true A summary object covering the time range before the given one with the same duration
summary UseCaseSummary true A summary object covering the given time range

UseCaseResponse

{
  "accuracyHealth": "string",
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "inProductionWarning": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "modelHealth": "string",
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "predictionsCount": "string",
  "realizedValue": "string",
  "serviceHealth": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Properties

Name Type Required Restrictions Description
accuracyHealth any false The health of the accuracy

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous UseCaseHealthInformation false none

continued

Name Type Required Restrictions Description
businessImpact integer¦null false maximum: 5
minimum: 1
Expected effects on overall business operations
commentId string false The id for this comment
content string false A string
description string¦null false Use case description
feasibility integer¦null false maximum: 5
minimum: 1
Assessment of how the use case can be accomplished across multiple dimensions
id string false The id of the use case
inProductionWarning string¦null false An optional warning to indicate that deployments are attached to this use case.
mentions [DrUserId] false A list of user objects
modelHealth any false The health of the model

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous UseCaseHealthInformation false none

continued

Name Type Required Restrictions Description
name string false Name of the use case
notes string¦null false User notes
owner DrUserId false User case owner
permissions [string]¦null false Permissions of current user
potentialValue MonetaryValue false Optional, Contains MonetaryValue objects
potentialValueTemplate any false Optional, Contains Template type and parameter information

anyOf

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateClassification false none

or

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateRegression false none

continued

Name Type Required Restrictions Description
predictionTargets [string] false An array of strings prediction target names
predictionsCount any false Count of the number of predictions made.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous [integer]¦null false A list of prediction counts.

continued

Name Type Required Restrictions Description
realizedValue any false Optional, Contains MonetaryValue objects

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous MonetaryValue false none

continued

Name Type Required Restrictions Description
serviceHealth any false The health of the service

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous UseCaseHealthInformation false none

continued

Name Type Required Restrictions Description
stage string false Current stage of use case
targetDates [TargetDate]¦null false Array of TargetDate objects

Enumerated Values

Property Value
stage ideation
stage queued
stage dataPrepAndModeling
stage validatingAndDeploying
stage inProduction
stage retired
stage onHold

UseCaseSharingListResponse

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "OWNER",
      "shareRecipientType": "user"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true The number of items returned on this page
data [SharingListData] true A list of sharing role objects
next string(uri)¦null true URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true The number of items matching the query condition

UseCaseSharingUpdate

{
  "operation": "updateRoles",
  "roles": [
    {
      "id": "string",
      "role": "OWNER",
      "shareRecipientType": "user",
      "username": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
operation string true The name of the action being taken. Only 'updateRoles' is supported.
roles [SharingRoleUpdateData] true A list of sharing role objects

Enumerated Values

Property Value
operation updateRoles

UseCaseSummary

{
  "averagePredictionsCount": 0,
  "averageRealizedValue": 0,
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "totalPredictionsCount": 0,
  "totalRealizedValue": 0
}

Properties

Name Type Required Restrictions Description
averagePredictionsCount integer true Average number of predictions per bucket during this time period
averageRealizedValue integer false Average amount of value per bucket realised during this time period
period UseCaseBucketPeriod true A period object describing the time this bucket covers
totalPredictionsCount integer false Total number of predictions that happened during this time period
totalRealizedValue integer true Total amount of value realised during this time period

UseCaseUpdate

{
  "businessImpact": 1,
  "description": "string",
  "feasibility": 1,
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "realizedValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Properties

Name Type Required Restrictions Description
businessImpact integer¦null false maximum: 5
minimum: 1
Expected effects on overall business operations
description string¦null false maxLength: 1024
Use case description
feasibility integer¦null false maximum: 5
minimum: 1
Assessment of how the use case can be accomplished across multiple dimensions
name string false maxLength: 512
Name of the use case
notes string¦null false maxLength: 1024
User notes
owner DrUserId false User case owner
potentialValue MonetaryValue false Contains MonetaryValue objects
potentialValueTemplate any false Contains Template type and parameter information defined in the response of GET /api/v2/useCaseValueTemplates/{templateType}/calculation/

anyOf

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateClassification false none

or

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateRegression false none

continued

Name Type Required Restrictions Description
predictionTargets [string]¦null false An array of strings prediction target names
realizedValue MonetaryValue false Contains MonetaryValue objects
stage string false Current stage of use case
targetDates [TargetDate]¦null false Array of TargetDate objects

Enumerated Values

Property Value
stage ideation
stage queued
stage dataPrepAndModeling
stage validatingAndDeploying
stage inProduction
stage retired
stage onHold

UseCaseValueCalculateTemplate

{
  "data": {
    "accuracyImprovement": 0,
    "decisionsCount": 0,
    "incorrectDecisionCost": 0,
    "incorrectDecisionsCount": 0
  },
  "templateType": "classification"
}

Properties

Name Type Required Restrictions Description
data any true Data used for calculating the result

oneOf

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateClassificationData false none

xor

Name Type Required Restrictions Description
» anonymous UseCaseValueTemplateRegressionData false none

continued

Name Type Required Restrictions Description
templateType string true The name of the use case value template

Enumerated Values

Property Value
templateType classification
templateType regression

UseCaseValueTemplateCalculateResponse

{
  "averageValuePerDecision": 0,
  "savedAnnually": 0,
  "template": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  }
}

Properties

Name Type Required Restrictions Description
averageValuePerDecision number true Estimated average value per decision
savedAnnually number true Estimated amount saved annually
template UseCaseValueCalculateTemplate true Template type and data used for calculating the result

UseCaseValueTemplateClassification

{
  "data": {
    "accuracyImprovement": 0,
    "decisionsCount": 0,
    "incorrectDecisionCost": 0,
    "incorrectDecisionsCount": 0
  },
  "templateType": "classification"
}

Properties

Name Type Required Restrictions Description
data UseCaseValueTemplateClassificationData true Use case value data
templateType string true Use case value template type

Enumerated Values

Property Value
templateType classification

UseCaseValueTemplateClassificationData

{
  "accuracyImprovement": 0,
  "decisionsCount": 0,
  "incorrectDecisionCost": 0,
  "incorrectDecisionsCount": 0
}

Properties

Name Type Required Restrictions Description
accuracyImprovement number true Accuracy improvement
decisionsCount integer true Estimated number of decisions per year
incorrectDecisionCost number true Estimated cost of an individual incorrect decision
incorrectDecisionsCount integer true Estimated number of incorrect decisions per year

UseCaseValueTemplateParameterWithSchema

{
  "parameterName": "string",
  "schema": {
    "elementType": "integer",
    "label": "string",
    "maximum": 0,
    "minimum": 0,
    "placeholder": "string",
    "unit": "string"
  }
}

Properties

Name Type Required Restrictions Description
parameterName string true Name of the parameter
schema UseCaseValueTemplateSchema true Schema entry defining the type and limits of a template parameter

UseCaseValueTemplateRegression

{
  "data": {
    "accuracyImprovement": 0,
    "decisionsCount": 0,
    "targetValue": 0
  },
  "templateType": "regression"
}

Properties

Name Type Required Restrictions Description
data UseCaseValueTemplateRegressionData true Use case value data
templateType string true Use case value template type

Enumerated Values

Property Value
templateType regression

UseCaseValueTemplateRegressionData

{
  "accuracyImprovement": 0,
  "decisionsCount": 0,
  "targetValue": 0
}

Properties

Name Type Required Restrictions Description
accuracyImprovement number true Accuracy improvement
decisionsCount integer true Estimated number of decisions per year
targetValue number true Target value

UseCaseValueTemplateResponse

{
  "description": "string",
  "schema": [
    {
      "parameterName": "string",
      "schema": {
        "elementType": "integer",
        "label": "string",
        "maximum": 0,
        "minimum": 0,
        "placeholder": "string",
        "unit": "string"
      }
    }
  ],
  "templateType": "classification",
  "title": "string"
}

Properties

Name Type Required Restrictions Description
description string true Description of Value Template
schema [UseCaseValueTemplateParameterWithSchema] true Schema definition of all template parameters
templateType string true The name of the use case value template to be retrieved
title string true Title of Value Template

Enumerated Values

Property Value
templateType classification
templateType regression

UseCaseValueTemplateSchema

{
  "elementType": "integer",
  "label": "string",
  "maximum": 0,
  "minimum": 0,
  "placeholder": "string",
  "unit": "string"
}

Properties

Name Type Required Restrictions Description
elementType string true Possible types used for template variables
label string true Label describing the represented value
maximum integer¦null true Sets Maximum value if given
minimum integer¦null true Sets Minimum value if given
placeholder string true Text that can be used to prefill an input filed for the value
unit string¦null true Unit type. e.g. %

Enumerated Values

Property Value
elementType integer
elementType float
elementType number

Updated May 27, 2023
Back to top