Data Generation

Data Generation - Find All

HTTP Request

GET /api/data-generation

Interactive Demo

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "processId": "string",
    "targetId": "string",
    "operationType": "GENERATION",
    "status": "PENDING",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "totalDurationMs": 0,
    "totalRecordsProcessed": 0,
    "errorMessage": "string",
    "errorStackTrace": "string",
    "notes": "string",
    "steps": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "stepType": "COUNTRY_GENERATOR",
        "executionOrder": 0,
        "status": "PENDING",
        "start": "2019-08-24T14:15:22Z",
        "end": "2019-08-24T14:15:22Z",
        "durationMs": 0,
        "recordsProcessed": 0,
        "chunkSize": 0
      }
    ]
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DataGeneration]	false	none	none
» createdBy	string	false	none	none
» lastModifiedBy	string	false	none	none
» createdDate	string(date-time)	false	none	none
» lastModifiedDate	string(date-time)	false	none	none
» archived	boolean	false	none	none
» externalId	string	false	none	none
» id	integer(int64)	false	none	none
» processId	string	false	none	none
» targetId	string	false	none	none
» operationType	string	false	none	none
» status	string	false	none	none
» start	string(date-time)	false	none	none
» end	string(date-time)	false	none	none
» totalDurationMs	integer(int64)	false	none	none
» totalRecordsProcessed	integer(int32)	false	none	none
» errorMessage	string	false	none	none
» errorStackTrace	string	false	none	none
» notes	string	false	none	none
» steps	[DataGenerationStep]	false	none	none
»» createdBy	string	false	none	none
»» lastModifiedBy	string	false	none	none
»» createdDate	string(date-time)	false	none	none
»» lastModifiedDate	string(date-time)	false	none	none
»» archived	boolean	false	none	none
»» externalId	string	false	none	none
»» id	integer(int64)	false	none	none
»» stepType	string	false	none	none
»» executionOrder	integer(int32)	false	none	none
»» status	string	false	none	none
»» start	string(date-time)	false	none	none
»» end	string(date-time)	false	none	none
»» durationMs	integer(int64)	false	none	none
»» recordsProcessed	integer(int32)	false	none	none
»» chunkSize	integer(int32)	false	none	none

Enumerated Values

Attribute	Value
operationType	DESTRUCTION, GENERATION
status	CANCELLED, COMPLETED, DESTROYED, FAILED, PENDING, RUNNING
stepType	ADDRESS_DESTROYER, ADDRESS_GENERATOR, CITY_DESTROYER, CITY_GENERATOR, COUNTRY_DESTROYER, COUNTRY_GENERATOR, LEASE_DESTROYER, LEASE_GENERATOR, LEASE_NOTE_DESTROYER, LEASE_NOTE_GENERATOR, LOCATION_DESTROYER, LOCATION_GENERATOR, LOCATION_NOTE_DESTROYER, LOCATION_NOTE_GENERATOR, PREMISE_DESTROYER, PREMISE_GENERATOR, PREMISE_NOTE_DESTROYER, PREMISE_NOTE_GENERATOR, PROVINCE_DESTROYER, PROVINCE_GENERATOR, TERM_DEFINITION_DESTROYER, TERM_DEFINITION_GENERATOR

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

Data Generation - Generate

HTTP Request

POST /api/data-generation

Interactive Demo

Parameters

Name	In	Type	Required	Description
body	body	DataGenerationConfiguration	false	none

Body Parameters

{
  "locations": 0,
  "premises": 0,
  "leases": 0,
  "termDefinitions": 0
}

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	DataGeneration

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "processId": "string",
  "targetId": "string",
  "operationType": "GENERATION",
  "status": "PENDING",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "totalDurationMs": 0,
  "totalRecordsProcessed": 0,
  "errorMessage": "string",
  "errorStackTrace": "string",
  "notes": "string",
  "steps": [
    {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "stepType": "COUNTRY_GENERATOR",
      "executionOrder": 0,
      "status": "PENDING",
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "durationMs": 0,
      "recordsProcessed": 0,
      "chunkSize": 0
    }
  ]
}

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

Data Generation - Find By ID

HTTP Request

GET /api/data-generation/{id}

Interactive Demo

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	DataGeneration

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "processId": "string",
  "targetId": "string",
  "operationType": "GENERATION",
  "status": "PENDING",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "totalDurationMs": 0,
  "totalRecordsProcessed": 0,
  "errorMessage": "string",
  "errorStackTrace": "string",
  "notes": "string",
  "steps": [
    {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "stepType": "COUNTRY_GENERATOR",
      "executionOrder": 0,
      "status": "PENDING",
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "durationMs": 0,
      "recordsProcessed": 0,
      "chunkSize": 0
    }
  ]
}

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

Data Generation - Delete By ID

HTTP Request

DELETE /api/data-generation/{id}

Interactive Demo

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	none

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None

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

Data Generation - Find By Process ID

HTTP Request

GET /api/data-generation/process/{processId}

Interactive Demo

Parameters

Name	In	Type	Required	Description
processId	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	DataGeneration

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "processId": "string",
  "targetId": "string",
  "operationType": "GENERATION",
  "status": "PENDING",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "totalDurationMs": 0,
  "totalRecordsProcessed": 0,
  "errorMessage": "string",
  "errorStackTrace": "string",
  "notes": "string",
  "steps": [
    {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "stepType": "COUNTRY_GENERATOR",
      "executionOrder": 0,
      "status": "PENDING",
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "durationMs": 0,
      "recordsProcessed": 0,
      "chunkSize": 0
    }
  ]
}

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

Data Generation - Destroy By Process ID

HTTP Request

DELETE /api/data-generation/process/{processId}

Interactive Demo

Parameters

Name	In	Type	Required	Description
processId	path	string	true	none

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None

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

Data Generation - Cleanup

HTTP Request

DELETE /api/data-generation/cleanup

Interactive Demo

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None

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

Data Generation - Destroy All

HTTP Request

DELETE /api/data-generation/all

Interactive Demo

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None

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

---