---
# System prepended metadata

title: profiling and development-tool-info

---

# profiling and development-tool-info

把 report 結果存在 db
```
table - datatable profiling
id, datatable_uuid, content(text)
```

## API

### CreateDatableProfilingJob

POST 
/api/sharing/v1/datatables/{datatable_uuid}/profiling-jobs

ResponseBody: 
```json
{
    "uuid": "uuid",
    "datatable_uuid": "uuid",
    "status": "running" // "failed", "success", "stopped"
    "logs": "aaaaaa"
    "app_id": "applicationID_123123123"
    "createdAt": "20110101",
    "updatedAt" "20110101"
}
```

### GetDatableProfilingJobs

GET
/api/sharing/v1/datatables/{datatable_uuid}/profiling-jobs

ResponseBody: 
```json
{
    "jobs": [
        {
            "uuid": "uuid",
            "datatable_uuid": "uuid",
            "status": "running", // "failed", "success", "stopped"
            "logs": "aaaaaa"
            "app_id": "applicationID_123123123",
            "createdAt": "20110101",
            "updatedAt" "20110101"
        }
    ]
}
```

### GetDatableProfilingReport
GET 
/api/sharing/v1/datatables/{datatable_uuid}/profiling-report

ResponseBody: HTML

### GetFilteredDatableProfilingReport
GET
/api/sharing/v1/contracts/{contract_uuid}/datatables/{datatable_uuid}/profiling-report

ResponseBody: HTML

### GetFilteredDatableProfilingReportInternal
GET
/internal/v1/development-tool/datatables/{datatable_uuid}/profiling-report

ResponseBody: HTML

### GetDevelopmentTooLContractInfo

GET 
/internal/v1/development-tool/contract-info

HEADER: 
x-sds-development-tool-license: contractUUID

ResponseBody: 
| Name | Type | Required | Description |
| -- | -- | -- | -- |
| contract | Object | true | Result message. |
```json
{
  "contract": {
      "title": "Demo Contract",
      "input_datasets": [
        {
          "uuid": "3746ddc8-d6f6-4c8c-88eb-f931bd0b143c",
          "name": "demo_input_dataset",
          "datatables": [
            {
              "uuid": "75cd419e-43b5-4c3a-9190-92ff9eca1717",
              "title": "demo_input_datatable_1",
              "binding": "alluxio://example/demo_input_dattable_1",
              "schema": [
                {
                  "name": "name",
                  "type": "string",
                  "is_partition_key": false,
                  "is_primary_key": false,
                  "data_sample": "",
                  "description": "",
                  "pii_sensitive": false
                },
                {
                  "name": "phone",
                  "type": "string",
                  "is_partition_key": false,
                  "is_primary_key": false,
                  "data_sample": "",
                  "description": "",
                  "pii_sensitive": false
                },
                {
                  "name": "address",
                  "type": "string",
                  "is_partition_key": false,
                  "is_primary_key": false,
                  "data_sample": "",
                  "description": "",
                  "pii_sensitive": false
                },
                {
                  "name": "email",
                  "type": "string",
                  "is_partition_key": false,
                  "is_primary_key": false,
                  "data_sample": "",
                  "description": "",
                  "pii_sensitive": true
                },
                {
                  "name": "ssn",
                  "type": "string",
                  "is_partition_key": false,
                  "is_primary_key": false,
                  "data_sample": "",
                  "description": "Social Security Number",
                  "pii_sensitive": true
                },
                {
                  "name": "gender",
                  "type": "char",
                  "is_partition_key": false,
                  "is_primary_key": false,
                  "data_sample": "",
                  "description": "",
                  "pii_sensitive": false
                },
                {
                  "name": "age",
                  "type": "integer",
                  "is_partition_key": false,
                  "is_primary_key": false,
                  "data_sample": "",
                  "description": "",
                  "pii_sensitive": false
                },
                {
                  "name": "lang",
                  "type": "string",
                  "is_partition_key": false,
                  "is_primary_key": false,
                  "data_sample": "",
                  "description": "",
                  "pii_sensitive": false
                },
                {
                  "name": "subscribed",
                  "type": "boolean",
                  "is_partition_key": false,
                  "is_primary_key": false,
                  "data_sample": "",
                  "description": "",
                  "pii_sensitive": false
                }
              ]
            }
          ]
        }
      ],
      "output_datasets": [
        {
          "uuid": "a060c6c2-d5ae-4c0f-a470-c0a52d5172a4",
          "title": "demo_output_dataset",
          "datatables": [
            {
              "uuid": "e2fcc457-259d-4bfe-b097-93f36309e0b5",
              "title": "demo_output_datatable",
              "binding": "alluxio://example/demo_output_datatable",
              "schema": [
                {
                  "name": "age",
                  "type": "integer",
                  "is_partition_key": false,
                  "is_primary_key": false,
                  "data_sample": "",
                  "description": "",
                  "pii_sensitive": false
                },
              ]
            }
          ]
        }
      ]
    }
}
```
