Skip to content

[ODM-13121] Update PC API flow #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
genestack-okunitsyn merged 2 commits into from
Feb 27, 2026
Merged

[ODM-13121] Update PC API flow #185

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e5aa3e
[ODM-13121] Update PC API flow
Feb 26, 2026
4cbb778
[ODM-13121] Update state of job
Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 22 additions & 8 deletions docs/user-guide/doc-odm-user-guide/attachment-transformation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,17 @@ GET `transformations/images`. Endpoint response example:
"output_formats": [
"samples"
]
},
{
"name": "metadata-basic",
"version": "0.0.3",
"description": "Basic converter from attachment to metadata",
"input_formats": [
"csv"
],
"output_formats": [
"samples"
]
},
{
"name": "metadata-basic",
Expand Down Expand Up @@ -81,7 +92,7 @@ Let’s create configuration that allows image to place transformed `CSV` file t
"data": {
"source": "csv",
"destination": "samples"
},
},
"description": "Configuration which allows you to transform csv file into Sample group",
"name": "csv to samples"
}
Expand Down Expand Up @@ -136,26 +147,28 @@ Initial request body:

```json
{
"attachment_accession": "string",
"input_accessions": ["string"],
"configuration_id": 1,
"image_reference": {
"name": "string",
"version": "string"
},
"volume_size": 30
"volume_size": 30,
"dry_run": false
}
```
Fill in information about attachment genestack accession, configuration, image name and version:

```json
{
"attachment_accession": "GSF016786",
"input_accessions": ["GSF016786"],
"configuration_id": 294862386,
"image_reference": {
"name": "metadata-basic",
"version": "0.0.2"
"version": "0.0.3"
},
"volume_size": 30
"volume_size": 30,
"dry_run": false
}
```

Expand All @@ -175,11 +188,12 @@ To check the status of the Job use GET `transformations/jobs/{id}` endpoint:
"$schema": "https://odm-processors-controller:8080/schemas/TransformationJobFields.json",
"image_reference": {
"name": "metadata-basic",
"version": "0.0.2"
"version": "0.0.3"
},
"attachment_accession": "GSF016786",
"input_accessions": ["GSF016786"],
"configuration_id": 294862386,
"volume_size": 30,
"dry_run": false,
"create_time": "2025-10-31T12:28:57Z",
"status": {
"state": "TERMINATED"
Expand Down