Update Instance Configuration

Request

Update the instances information.

You will need to call the GET /decisionEngine/instance/{guid} endpoint to get the current configuration and then update the fields you want to change.

Security

bearerToken

Path

guidstringrequired

get results by guid.

Bodyapplication/json

templateIdstringrequired

The template ID of the decision tree to be updated.

Example:"72a7e73e799a4c3ea2a8b89bd2002829"

guidstringrequired

The GUID to be updated.

Example:"02dce1bbb81b11ed962c01ff1787b18e"

decisionTreeNamestringrequired

The name of the decision tree to be updated.

Example:"Test US after NL test update5"

customerIdinteger

The customer ID to be updated.

Example:103361848

inputParamsobject

The input parameters to be updated can be obtained from the GET/instance configuration endpoint.

Example:

{
  "creditAmount": {
    "labelName": "Sales Amount",
    "failedStatus": 3,
    "unavailableStatus": 2,
    "isMandatory": true,
    "orderInde": 100,
    "fieldType": "Integer"
  }
}

configurationVariablesobject

The Configuration Variables to be updated can be obtained from the GET/instance configuration endpoint.

Example:

{
  "companyStatus": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2
  },
  "internationalScore": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": "B"
  },
  "riskScore": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": 50
  },
  "dbt": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": 1
  },
  "possibleOFAC": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2
  },
  "estimatedAnnualRevenue": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": 1000
  },
  "yearsInBusiness": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": 5
  },
  "derogatoryLegalFilingsCount": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": 3
  },
  "derogatoryLegalFilingsValue": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": 1000
  },
  "numberOfEmployees": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": 1000
  },
  "bankruptcy": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2
  },
  "totalNumberOfTradeLines": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": 25
  },
  "percentageOfTotalPastDue": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": 15
  },
  "percentageSeverelyPastDue": {
    "isRequired": true,
    "failedStatus": 2,
    "unavailableStatus": 2,
    "value": 10
  },
  "businessCompliance": {
    "isRequired": false,
    "failedStatus": null,
    "unavailableStatus": 2,
    "value": null
  },
  "directorCompliance": {
    "isRequired": true,
    "failedStatus": null,
    "unavailableStatus": null,
    "value": null
  }
}

scalarVariablesobject

The Scalar Variables to be updated can be obtained from the GET/instance configuration endpoint.

Example:

{
  "creditLimitAdjustmentModifier": {
    "isRequired": false,
    "value": 1
  }
}

curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/decisionEngine/instance/{guid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "templateId": "72a7e73e799a4c3ea2a8b89bd2002829",
    "guid": "232101f5cfbf11edb2a53f274007bfbe",
    "decisionTreeName": "Default US-Test Tree",
    "customerId": 103361848,
    "inputParams": {
      "creditAmount": {
        "labelName": "Sales Amount",
        "failedStatus": 3,
        "unavailableStatus": 2,
        "isMandatory": true,
        "orderInde": 100,
        "fieldType": "Integer"
      }
    },
    "configurationVariables": {
      "companyStatus": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2
      },
      "internationalScore": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": "B"
      },
      "riskScore": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 50
      },
      "dbt": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 1
      },
      "possibleOFAC": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2
      },
      "estimatedAnnualRevenue": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 1000
      },
      "yearsInBusiness": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 5
      },
      "derogatoryLegalFilingsCount": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 3
      },
      "derogatoryLegalFilingsValue": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 1000
      },
      "numberOfEmployees": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 1000
      },
      "bankruptcy": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2
      },
      "totalNumberOfTradeLines": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 25
      },
      "percentageOfTotalPastDue": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 15
      },
      "percentageSeverelyPastDue": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 10
      },
      "businessCompliance": {
        "isRequired": false,
        "failedStatus": null,
        "unavailableStatus": 2,
        "value": null
      },
      "directorCompliance": {
        "isRequired": true,
        "failedStatus": null,
        "unavailableStatus": null,
        "value": null
      }
    },
    "scalarVariables": {
      "creditLimitAdjustmentModifier": {
        "isRequired": false,
        "value": 1
      }
    },
    "publilshed": true
  }'

Responses

Bodyapplication/json

object(CreditsafeGlobalDataReportsCompanyReportExtraSection)

Response

{}