Doküman Listesi
Bu Sayfada

API Referans: Süreçler

Process Endpoints

List Processes

Bir tenant’taki tüm process’leri listeleyin.

Endpoint: GET /tenant/{tenantId}/processes

Parameters:

NameTypeLocationRequiredDescription
tenantIdstringpathYesTenant’ın benzersiz kimliği

Response:

[
	{
		"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
		"displayName": "Order to Cash",
		"treeNodeType": "Process",
		"treeParentId": null,
		"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"createdAt": "2024-03-01T09:00:00Z",
		"updatedAt": "2024-03-15T16:30:00Z"
	}
]

Create Process

Tenant içinde yeni bir process oluşturun.

Endpoint: POST /tenant/{tenantId}/processes

Parameters:

NameTypeLocationRequiredDescription
tenantIdstringpathYesTenant’ın benzersiz kimliği

Request Body:

{
	"displayName": "My New Process",
	"treeNodeType": "Process",
	"treeParentId": null
}
FieldTypeRequiredDescription
displayNamestringYesProcess adı
treeNodeTypestringNoProcess (varsayılan) veya TreeGroup olmalı
treeParentIdstringNoProcess’leri klasörlemek için üst klasör ID’si

Response: Oluşturulan process objesini döner.


Get Process

Belirli bir process’in detaylarını görüntüleyin.

Endpoint: GET /tenant/{tenantId}/processes/{processId}

Parameters:

NameTypeLocationRequiredDescription
tenantIdstringpathYesTenant’ın benzersiz kimliği
processIdstringpathYesProcess’in benzersiz kimliği

Response:

{
	"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
	"displayName": "Order to Cash",
	"treeNodeType": "Process",
	"treeParentId": null,
	"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
	"createdAt": "2024-03-01T09:00:00Z",
	"updatedAt": "2024-03-15T16:30:00Z"
}

Update Process

Bir process’i güncelleyin (isim değişikliği veya farklı bir klasöre taşıma).

Endpoint: PUT /tenant/{tenantId}/processes/{processId}

Parameters:

NameTypeLocationRequiredDescription
tenantIdstringpathYesTenant’ın benzersiz kimliği
processIdstringpathYesProcess’in benzersiz kimliği

Request Body:

{
	"displayName": "Updated Process Name",
	"treeParentId": "d0e1f2a3-b4c5-6789-def0-123456789012"
}
FieldTypeRequiredDescription
displayNamestringNoProcess için yeni isim
treeParentIdstringNoYeni üst klasör ID’si

Response: Güncellenen process objesini döner.


Delete Process

Bir process ve ilişkili verilerini silin.

Endpoint: DELETE /tenant/{tenantId}/processes/{processId}

Parameters:

NameTypeLocationRequiredDescription
tenantIdstringpathYesTenant’ın benzersiz kimliği
processIdstringpathYesProcess’in benzersiz kimliği

Response:

{
	"success": true
}

Upload BPMN

Bir process modelini tanımlamak veya güncellemek için BPMN XML dosyası yükleyin.

Endpoint: PUT /tenant/{tenantId}/processes/{processId}/bpmn

Parameters:

NameTypeLocationRequiredDescription
tenantIdstringpathYesTenant’ın benzersiz kimliği
processIdstringpathYesProcess’in benzersiz kimliği

Request Body:

{
	"bpmnXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}
FieldTypeRequiredDescription
bpmnXmlstringYesBPMN 2.0 XML içeriği (string olarak)

Response: Yeni model ile güncellenen process objesini döner.


Process Data Mapping Endpoints

Data mapping’ler, datatable’ları süreçlere bağlayarak event log verinizi process modeli üzerinde görselleştirmenizi ve analiz etmenizi sağlar.

List Process Mappings

Bir process’e ait tüm data mapping’lerini görüntüleyin.

Endpoint: GET /tenant/{tenantId}/processes/{processId}/mappings

Parameters:

NameTypeLocationRequiredDescription
tenantIdstringpathYesTenant’ın benzersiz kimliği
processIdstringpathYesProcess’in benzersiz kimliği

Response:

[
	{
		"id": "e1f2a3b4-c5d6-7890-efa1-234567890123",
		"modelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
		"displayName": "Sales Data 2024",
		"color": { "id": "data-1" },
		"showByDefault": true,
		"createdAt": "2024-03-10T11:00:00Z"
	}
]

Create Process Mapping

Bir sürece data table mapping ekleyin.

Endpoint: POST /tenant/{tenantId}/processes/{processId}/mappings

Parameters:

NameTypeLocationRequiredDescription
tenantIdstringpathYesTenant’ın benzersiz kimliği
processIdstringpathYesProcess’in benzersiz kimliği

Request Body:

{
	"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
	"displayName": "Sales Data 2024",
	"color": { "id": "data-1" },
	"showByDefault": true
}
FieldTypeRequiredDescription
dataTableIdstringYesMapping yapılacak datatable’ın ID’si
displayNamestringNoMapping için görünen isim
colorobjectNoRenk nesnesi (id alanı ile, data-1 ~ data-11)
showByDefaultbooleanNoVarsayılan olarak gösterilsin mi (varsayılan: true)

Response: Oluşturulan mapping objesini döner.


Update Process Mapping

Var olan bir data mapping’in görünüm ayarlarını güncelleyin.

Endpoint: PUT /tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Parameters:

NameTypeLocationRequiredDescription
tenantIdstringpathYesTenant’ın benzersiz kimliği
processIdstringpathYesProcess’in benzersiz kimliği
mappingIdstringpathYesMapping’in benzersiz kimliği

Request Body:

{
	"displayName": "Updated Name",
	"color": { "id": "data-2" },
	"showByDefault": false
}
FieldTypeRequiredDescription
displayNamestringNoYeni görünen isim
colorobjectNoRenk nesnesi (id alanı ile, data-1 ~ data-11)
showByDefaultbooleanNoVarsayılan görünürlük

Response: Güncellenen mapping objesini döner.


Delete Process Mapping

Bir process üzerinden data mapping’i kaldırın.

Endpoint: DELETE /tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Parameters:

NameTypeLocationRequiredDescription
tenantIdstringpathYesTenant’ın benzersiz kimliği
processIdstringpathYesProcess’in benzersiz kimliği
mappingIdstringpathYesMapping’in benzersiz kimliği

Response:

{
	"success": true
}