Skip to main content
PUT
/
v1
/
analyses
/
{analysisId}
Update Analysis
curl --request PUT \
  --url https://localtest.mindbridge.ai/api/v1/analyses/{analysisId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 123,
  "name": "<string>",
  "analysisPeriods": [
    {
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "id": {},
      "interimAsAtDate": "2023-12-25"
    }
  ],
  "currencyCode": "<string>",
  "archived": true
}
'
{
  "version": 123,
  "engagementId": {},
  "analysisTypeId": {},
  "name": "<string>",
  "analysisPeriods": [
    {
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "id": {},
      "interimAsAtDate": "2023-12-25"
    }
  ],
  "currencyCode": "<string>",
  "id": {},
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": {},
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": {},
    "userName": "<string>"
  },
  "interim": true,
  "archived": true,
  "converted": true,
  "periodic": true,
  "importantColumns": [
    {
      "columnName": "<string>",
      "field": "<string>"
    }
  ],
  "analysisPeriodGaps": [
    {
      "analysisPeriodId": {},
      "previousAnalysisPeriodId": {},
      "days": 123
    }
  ],
  "latestAnalysisResultId": {},
  "referenceId": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

analysisId
string
required

Body

application/json
version
integer<int64>
required

Indicates the data integrity version to ensure data consistency.

name
string
required

The name of the analysis.

Required string length: 1 - 80
Pattern: \s*\S+.*
analysisPeriods
object[]
required

Details about the specific analysis periods under audit.

currencyCode
string
required

The currency to be displayed across the analysis results.

archived
boolean

Indicates whether or not the analysis has been archived.

Response

OK

version
integer<int64>
required

Indicates the data integrity version to ensure data consistency.

engagementId
object
required

Identifies the associated engagement.

analysisTypeId
object
required

Identifies the type of analysis.

name
string
required

The name of the analysis.

Required string length: 1 - 80
Pattern: \s*\S+.*
analysisPeriods
object[]
required

Details about the specific analysis periods under audit.

currencyCode
string
required

The currency to be displayed across the analysis results.

id
object

The unique object identifier.

creationDate
string<date-time>

The date that the object was originally created.

lastModifiedDate
string<date-time>

The date that the object was last updated or modified.

createdUserInfo
User Info · object

Details about the user who created the object.

lastModifiedUserInfo
User Info · object

Details about the user who last modified or updated the object.

interim
boolean

Indicates whether or not the analysis is using an interim time frame.

archived
boolean

Indicates whether or not the analysis has been archived.

converted
boolean

Indicates whether or not an interim analysis time frame has been converted to a full analysis time frame.

periodic
boolean

Indicates whether or not the analysis is using a periodic time frame.

importantColumns
object[]

Additional data columns that can be used when importing additional data.

analysisPeriodGaps
object[]

Details about the gap in time between two analysis periods.

latestAnalysisResultId
object
referenceId
string

A reference ID to identify the analysis.

Maximum string length: 256