Get processes
A quick tutorial on how to get the process_id
Whenever you upload your files, they go to a selected process.
The following endpoint returns the list of processes along with process_ids:
Get processes
GET /api/v0.3/processes
Query Parameters
Name
Type
offset
Integer
limit
Integer
order
String
query
String
status
String
process_type_id
String
user_id
String
{
"processes": [
{
"id": "db5f9a6d63da4e0795a3f73bfbf56a8d",
"name": "test Kasia invoices",
"typeId": "bbe7f45aea884e74bbd011a5f57e87f0",
"typeName": "Invoices",
"status": "Ready",
"version": "0.1",
"lastUpdated": "2023-06-07T09:47:29Z",
"usage": 2,
"orgId": "org_Bi1xYf9RLwZV5RUu",
"createdBy": "google-oauth2|115269842468606867512",
"createdAt": "2023-06-07T09:47:29Z",
"updatedAt": "2023-06-07T09:49:36Z",
"accesses": {
"google-oauth2|115269842468606867512": {
"subjectId": "google-oauth2|115269842468606867512",
"role": "owner",
"permissions": [
"workspace.collection:read",
"workspace.result:read",
"workspace.process:read",
"workspace.collection:create",
"workspace.collection:update",
"workspace.collection:delete",
"workspace.file:upload",
"workspace.file:download",
"workspace.result:create",
"workspace.result:update",
"workspace.result:delete",
"workspace.process:update",
"workspace.process:delete",
"workspace.admin.user:read",
"workspace.admin.user:invite",
"workspace.admin.user:manage",
"workspace.admin.collection:manage"
],
"grantedAt": "2023-06-07T09:47:29Z",
"grantedBy": "google-oauth2|115269842468606867512"
}
}
},
{
"id": "4c7adfa724cc41d984c63c63fe3d7ffb",
"name": "Michu na temacie",
"typeId": "bbe7f45aea884e74bbd011a5f57e87f0",
"typeName": "Invoices",
"status": "Ready",
"version": "0.1",
"lastUpdated": "2023-06-06T14:25:51Z",
"usage": 0,
"orgId": "org_Bi1xYf9RLwZV5RUu",
"createdBy": "auth0|63ea07ab2bc88f865b8df2d6",
"createdAt": "2023-06-06T14:25:51Z",
"updatedAt": "2023-06-06T14:25:51Z",
"accesses": {
"auth0|63ea07ab2bc88f865b8df2d6": {
"subjectId": "auth0|63ea07ab2bc88f865b8df2d6",
"role": "owner",
"permissions": [
"workspace.collection:read",
"workspace.result:read",
"workspace.process:read",
"workspace.collection:create",
"workspace.collection:update",
"workspace.collection:delete",
"workspace.file:upload",
"workspace.file:download",
"workspace.result:create",
"workspace.result:update",
"workspace.result:delete",
"workspace.process:update",
"workspace.process:delete",
"workspace.admin.user:read",
"workspace.admin.user:invite",
"workspace.admin.user:manage",
"workspace.admin.collection:manage"
],
"grantedAt": "2023-06-06T14:25:51Z",
"grantedBy": "auth0|63ea07ab2bc88f865b8df2d6"
}
}
},
{
"id": "ac227368aa59409886ce7bb3f0b8b361",
"name": "Michu na custom testach",
"typeId": "29b0618e37a94dc9950e7fcfaff338b9",
"typeName": "Custom",
"status": "Ready",
"version": "0.1",
"lastUpdated": "2023-06-06T13:06:15Z",
"usage": 14,
"orgId": "org_Bi1xYf9RLwZV5RUu",
"createdBy": "auth0|63ea07ab2bc88f865b8df2d6",
"createdAt": "2023-06-06T13:06:15Z",
"updatedAt": "2023-06-06T13:15:57Z",
"accesses": {
"auth0|63ea07ab2bc88f865b8df2d6": {
"subjectId": "auth0|63ea07ab2bc88f865b8df2d6",
"role": "owner",
"permissions": [
"workspace.collection:read",
"workspace.result:read",
"workspace.process:read",
"workspace.collection:create",
"workspace.collection:update",
"workspace.collection:delete",
"workspace.file:upload",
"workspace.file:download",
"workspace.result:create",
"workspace.result:update",
"workspace.result:delete",
"workspace.process:update",
"workspace.process:delete",
"workspace.admin.user:read",
"workspace.admin.user:invite",
"workspace.admin.user:manage",
"workspace.admin.collection:manage"
],
"grantedAt": "2023-06-06T13:06:15Z",
"grantedBy": "auth0|63ea07ab2bc88f865b8df2d6"
}
}
}
],
"pagination": {
"offset": 0,
"limit": 3,
"total": 30
}
}{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}curl -X 'GET' \
'https://workspace.alphamoon.ai/api/v0.3/processes?offset=0&limit=3&order=created_date%3Adesc' \
-H 'accept: application/json' \
-H 'Authorization: Basic API_KEY_BASE64_ENCODED'{
"processes": [
{
"id": "db5f9a6d63da4e0795a3f73bfbf56a8d",
"name": "test Kasia invoices",
"typeId": "bbe7f45aea884e74bbd011a5f57e87f0",
"typeName": "Invoices",
"status": "Ready",
"version": "0.1",
"lastUpdated": "2023-06-07T09:47:29Z",
"usage": 2,
"orgId": "org_Bi1xYf9RLwZV5RUu",
"createdBy": "google-oauth2|115269842468606867512",
"createdAt": "2023-06-07T09:47:29Z",
"updatedAt": "2023-06-07T09:49:36Z",
"accesses": {
"google-oauth2|115269842468606867512": {
"subjectId": "google-oauth2|115269842468606867512",
"role": "owner",
"permissions": [
"workspace.collection:read",
"workspace.result:read",
"workspace.process:read",
"workspace.collection:create",
"workspace.collection:update",
"workspace.collection:delete",
"workspace.file:upload",
"workspace.file:download",
"workspace.result:create",
"workspace.result:update",
"workspace.result:delete",
"workspace.process:update",
"workspace.process:delete",
"workspace.admin.user:read",
"workspace.admin.user:invite",
"workspace.admin.user:manage",
"workspace.admin.collection:manage"
],
"grantedAt": "2023-06-07T09:47:29Z",
"grantedBy": "google-oauth2|115269842468606867512"
}
}
},
{
"id": "4c7adfa724cc41d984c63c63fe3d7ffb",
"name": "Michu na temacie",
"typeId": "bbe7f45aea884e74bbd011a5f57e87f0",
"typeName": "Invoices",
"status": "Ready",
"version": "0.1",
"lastUpdated": "2023-06-06T14:25:51Z",
"usage": 0,
"orgId": "org_Bi1xYf9RLwZV5RUu",
"createdBy": "auth0|63ea07ab2bc88f865b8df2d6",
"createdAt": "2023-06-06T14:25:51Z",
"updatedAt": "2023-06-06T14:25:51Z",
"accesses": {
"auth0|63ea07ab2bc88f865b8df2d6": {
"subjectId": "auth0|63ea07ab2bc88f865b8df2d6",
"role": "owner",
"permissions": [
"workspace.collection:read",
"workspace.result:read",
"workspace.process:read",
"workspace.collection:create",
"workspace.collection:update",
"workspace.collection:delete",
"workspace.file:upload",
"workspace.file:download",
"workspace.result:create",
"workspace.result:update",
"workspace.result:delete",
"workspace.process:update",
"workspace.process:delete",
"workspace.admin.user:read",
"workspace.admin.user:invite",
"workspace.admin.user:manage",
"workspace.admin.collection:manage"
],
"grantedAt": "2023-06-06T14:25:51Z",
"grantedBy": "auth0|63ea07ab2bc88f865b8df2d6"
}
}
},
{
"id": "ac227368aa59409886ce7bb3f0b8b361",
"name": "Michu na custom testach",
"typeId": "29b0618e37a94dc9950e7fcfaff338b9",
"typeName": "Custom",
"status": "Ready",
"version": "0.1",
"lastUpdated": "2023-06-06T13:06:15Z",
"usage": 14,
"orgId": "org_Bi1xYf9RLwZV5RUu",
"createdBy": "auth0|63ea07ab2bc88f865b8df2d6",
"createdAt": "2023-06-06T13:06:15Z",
"updatedAt": "2023-06-06T13:15:57Z",
"accesses": {
"auth0|63ea07ab2bc88f865b8df2d6": {
"subjectId": "auth0|63ea07ab2bc88f865b8df2d6",
"role": "owner",
"permissions": [
"workspace.collection:read",
"workspace.result:read",
"workspace.process:read",
"workspace.collection:create",
"workspace.collection:update",
"workspace.collection:delete",
"workspace.file:upload",
"workspace.file:download",
"workspace.result:create",
"workspace.result:update",
"workspace.result:delete",
"workspace.process:update",
"workspace.process:delete",
"workspace.admin.user:read",
"workspace.admin.user:invite",
"workspace.admin.user:manage",
"workspace.admin.collection:manage"
],
"grantedAt": "2023-06-06T13:06:15Z",
"grantedBy": "auth0|63ea07ab2bc88f865b8df2d6"
}
}
}
],
"pagination": {
"offset": 0,
"limit": 3,
"total": 30
}
}See next:
Last updated