Public API

import { ORGANIZATION } from ‘@agnesuserguide/config’;

პროექტი: Heimdall Two Legged

გამოიყენეთ ეს API ორფეხა წვდომის ავტორიზაციისთვის და JWT ტოკენის დასაბრუნებლად. ტოკენი საჭიროა ავტორიზაციისთვის ყველა სხვა API მოთხოვნაში.

📁 კოლექცია: მომხმარებლები

საბოლოო წერტილი: მიიღეთ მომხმარებლები

აღწერა:

გამოიყენეთ ეს API, რომ მიიღოთ ობიექტების მასივი, რომელიც შეიცავს ორგანიზაციის მომხმარებლის მონაცემებს.

ობიექტის თვისებები:

საკუთრების გასაღები	ქონების ღირებულება	აღწერა
ორგ	UUID სტრიქონი	მომხმარებლის მშობელი ორგანიზაციის ID.
ქვე	UUID სტრიქონი	მომხმარებლის სააბონენტო ნომერი. გამოიყენება როგორც უნიკალური იდენტიფიკატორი მომხმარებლისთვის.
სახელი	სიმებიანი	მომხმარებლის სახელი.
გვარი	სიმებიანი	მომხმარებლის გვარი.
როლი	სიმებიანი	მომხმარებლის როლი სისტემაში. “მომხმარებელი”, “ადმინისტრატორი”, “სისტემა”
npi	ათნიშნა რიცხვი, როგორც სტრიქონი	ნაციონალური პროვაიდერის იდენტიფიკატორი არის უნიკალური 10-ნიშნა საიდენტიფიკაციო ნომერი, რომელიც გაცემულია ჯანდაცვის პროვაიდერებზე შეერთებულ შტატებში Medicare-ისა და Medicaid-ის სერვისების ცენტრების მიერ.

მაგალითი JSON დაბრუნების ობიექტი:

[
    {
        "org": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "sub": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "username": "frodobaggins@email.com",
        "firstname": "Frodo",
        "lastname": "Baggins",
        "role": "user",
        "npi": null
    },
    {
        "org": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "sub": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "username": "bilbobaggins@email.com",
        "firstname": "Bilbo",
        "lastname": "Baggins",
        "role": "administrator",
        "npi": null
    }
]

მეთოდი: მიიღეთ

{{baseUrl}}/api/v1/org/{{orgId}}/users

შეკითხვის პარამეტრები

პარამ	ღირებულება
ქვე	{{$guid}}
ჯგუფი	{{$guid}}

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

📁 კოლექცია: პორტალები

ბოლო წერტილი: მიიღეთ პორტალები

აღწერა:

გამოიყენეთ ეს API, რომ მიიღოთ ობიექტების მასივი, რომელიც შეიცავს ორგანიზაციის პორტალის მონაცემებს.

პორტალები არის სისტემაში რეგისტრირებული მომხმარებლის კომპიუტერის ვირტუალური წარმოდგენა.

ობიექტის თვისებები:

საკუთრების გასაღები	ქონების ღირებულება	აღწერა
მონაცემები	UUID სტრიქონი	მონაცემები

მაგალითი JSON დაბრუნების ობიექტი:

[
    {
        "data": "data"
    },
    {
        "data": "data"
    }
]

მეთოდი: მიიღეთ

{{baseUrl}}/api/v1/org/{{orgId}}/portals

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

📁 კოლექცია: ჯგუფები

ბოლო წერტილი: მიიღეთ ჯგუფები

გამოიყენეთ ეს API, რომ მიიღოთ ობიექტების მასივი, რომელიც შეიცავს ორგინიზაციური ჯგუფის მონაცემებს.

მეთოდი: მიიღეთ

{{baseUrl}}/api/v1/org/{{orgId}}/groups

პასუხი: 200

[
    {
        "id": "3s5*****-****-****-****-************",
        "org": "7ag*****-****-****-****-************",
        "name": "Administrators",
        "meta": {},
        "members": []
    },
    {
        "id": "9sd*****-****-****-****-************",
        "org": "53f*****-****-****-****-************",
        "name": "Test",
        "meta": {},
        "members": ["9ba*****-****-****-****-************"]
    }
]

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

ბოლო წერტილი: შექმენით ჯგუფი

გამოიყენეთ ეს API ორგანიზაციაში ახალი ჯგუფის შესაქმნელად.

მეთოდი: POST

{{baseUrl}}/api/v1/org/{{orgId}}/groups

სხეული (ნედლეული)

{
    "name": "{{$randomAdjective}} {{$randomNoun}}",
    "meta": {},
    "members": []
}

პასუხი: 200

{
    "id": "04a*****-****-****-****-************",
    "org": "040*****-****-****-****-************",
    "name": "back-end hard drive",
    "meta": {
        "meta": {}
    },
    "members": []
}

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

საბოლოო წერტილი: მიიღეთ ჯგუფი ID-ით

გამოიყენეთ ეს API ორგანიზაციაში მითითებული ჯგუფის მონაცემების შემცველი ობიექტის მისაღებად.

მეთოდი: მიიღეთ

{{baseUrl}}/api/v1/org/{{orgId}}/groups?id={{temporaryGroupId}}

შეკითხვის პარამეტრები

პარამ	ღირებულება
id	{{temporaryGroupId}}
id	717e4c96-847b-4b87-b22e-8488a7802d9a

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

დასასრული: ჯგუფის შეცვლა

გამოიყენეთ ეს API ორგანიზაციაში მითითებული ჯგუფის მონაცემების შესაცვლელად.

მეთოდი: PATCH

{{baseUrl}}/api/v1/org/{{orgId}}/groups/{{temporaryGroupId}}

სხეული (ნედლეული)

{
    "name": "{{$randomAdjective}} {{$randomNoun}}",
    "meta": {},
    "members": ["{{userId}}"]
}

პასუხი: 204

null

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

ბოლო წერტილი: ჯგუფის წაშლა

გამოიყენეთ ეს API ორგანიზაციაში მითითებული ჯგუფის წასაშლელად.

მეთოდი: წაშლა

{{baseUrl}}/api/v1/org/{{orgId}}/groups/{{temporaryGroupId}}

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

📁 კოლექცია: განრიგი

ბოლო წერტილი: მიიღეთ განრიგი

აღწერა:

გამოიყენეთ ეს API, რომ მიიღოთ ობიექტების მასივი, რომელიც შეიცავს ორგანიზაციის დაგეგმილ შეხვედრების მონაცემებს.

ობიექტის თვისებების დაბრუნება:

საკუთრების გასაღები	ქონების ღირებულება	აღწერა
პროვაიდერი	UUID სტრიქონი	სესიის მასპინძელი ექიმის პირადობის მოწმობა. მოპოვებულია მომხმარებლის sub თვისებიდან.
პაციენტი	ობიექტი	ობიექტი, რომელიც შეიცავს პაციენტის აღწერის თვისებებს.
პაციენტი.პაციენტის ID	სიმებიანი	უნიკალური იდენტიფიკატორი პაციენტისთვის.
პაციენტი.სახელი	სიმებიანი	პაციენტის სახელი.
პაციენტი.გვარი	სიმებიანი	პაციენტის გვარი.
პაციენტი.დაბადების თარიღი	თარიღი, როგორც წელი-თვე-თარიღი ფორმატი: წწწ-თთ-დდ	პაციენტის დაბადების თარიღი.
პაციენტი.სექსი	სიმებიანი	ბიოლოგიური იდენტიფიკატორი პაციენტისთვის. “M” ან “F”
სესიის ID	UUID სტრიქონი	უნიკალური ID, რომელიც აკავშირებს დაგეგმილ შეხვედრას პაციენტის მონაცემებთან. პორტალთან გაწევრიანებისას სესიის ID-ის მიწოდება მოიძიებს ნებისმიერ დაკავშირებულ პაციენტის მონაცემებს დაგეგმილ შეხვედრაზე. თუ პაციენტის მონაცემები არ იყო მოწოდებული დაგეგმილი შეხვედრის შექმნისას, მონაცემები არ იქნება შეტანილი.
პორტალი ID	64 ციფრიანი ნომერი	პორტალის ID, რომელშიც დაგეგმილია შეხვედრა.
დაწყების დრო	ISO ფორმატირებული თარიღი	დაგეგმილი შეხვედრის დაწყების დრო.
stopTime	ISO ფორმატირებული თარიღი	დაგეგმილი შეხვედრის დასრულების დრო.

მაგალითი JSON დაბრუნების ობიექტი:

[
    {
        "providerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "patient": {
            "patientId": "c",
            "firstName": "Larry",
            "lastName": "Friesen",
            "birthDate": "2001-12-02",
            "sex": "M"
        },
        "sessionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "portalId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        "startTime": "2021-12-02T06:07:49.000Z",
        "stopTime": "2021-12-02T08:00:24.000Z"
    }
]

მეთოდი: მიიღეთ

{{baseUrl}}/api/v1/org/{{orgId}}/schedule?startDate=2021-01-01&perPage=10&page=0

შეკითხვის პარამეტრები

პარამ	ღირებულება
დაწყების თარიღი	2021-01-01
გაჩერების თარიღი	2021-12-03
თითო გვერდზე	10
გვერდი	0
პორტალები.სახელი	პორტატული ტელეკლინიკა

პასუხი: 200

[]

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

ბოლო წერტილი: შექმენით განრიგის ელემენტი

აღწერა:

გამოიყენეთ ეს API ორგანიზაციისთვის ახალი დაგეგმილი შეხვედრის შესაქმნელად.

ობიექტის თვისებების დაბრუნება:

მართალია თუ დაგეგმილი შეხვედრა წარმატებით შეიქმნა

მცდარია თუ დაგეგმილი შეხვედრა წარმატებით შეიქმნა

მაგალითი JSON დაბრუნების ობიექტი:

true

მეთოდი: PUT

{{baseUrl}}/api/v1/org/{{orgId}}/schedule

სხეული (ნედლეული)

{
    "providerId": "{{userId}}",
    "patient": {
        "patientId": "{{$randomAlphaNumeric}}",
        "firstName": "{{$randomFirstName}}",
        "lastName": "{{$randomLastName}}",
        "birthDate": "{{randomDatePast}}",
        "sex": "M"
    },
    "sessionId": "{{$randomUUID}}",
    "portalId": "{{portalId}}",
    "startTime": "{{$randomDateRecent}}",
    "stopTime": "{{$randomDateRecent}}"
}

პასუხი: 200

true

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

საბოლოო წერტილი: მიიღეთ განრიგის ელემენტი ID-ით

აღწერა:

გამოიყენეთ ეს API, რომ მიიღოთ ობიექტი, რომელიც შეიცავს მონაცემებს ორგანიზაციის განსაზღვრული დაგეგმილი შეხვედრისთვის.

ობიექტის თვისებების დაბრუნება:

საკუთრების გასაღები	ქონების ღირებულება	აღწერა
მონაცემები	მონაცემები	მონაცემები

მაგალითი JSON დაბრუნების ობიექტი:

{
    // TODO
}

მეთოდი: მიიღეთ

{{baseUrl}}/api/v1/org/{{orgId}}/schedule/{{temporaryScheduleId}}

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

ბოლო წერტილი: წაშალეთ განრიგის ელემენტი

გამოიყენეთ ეს API ორგანიზაციაში მითითებული დაგეგმილი შეხვედრის წასაშლელად.

მეთოდი: წაშლა

{{baseUrl}}/api/v1/org/{{orgId}}/schedule/{{temporaryScheduleId}}

პასუხი: 200

{
    "sessionId": "1560f626-117f-4263-a068-46963357f30a",
    "providerId": null,
    "portalId": "8ad982843f36037b16450dd99c48663ecb6e031364241f146a906642efa9e101",
    "startTime": "2021-12-02T06:07:49.000Z",
    "stopTime": "2021-12-02T08:00:24.000Z",
    "meta": "{\"providerId\":\"b2f8d193-4e72-4d76-9dbf-677c86786ecb\",\"patient\":{\"patientId\":\"c\",\"firstName\":\"Larry\",\"lastName\":\"Friesen\",\"birthDate\":\"{{randomDatePast}}\",\"sex\":\"M\"}}"
}

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

📁 კოლექცია: ორგანიზაცია

საბოლოო წერტილი: მიიღეთ ორგანიზაციები

გამოიყენეთ ეს API ორგანიზაციისთვის მონაცემთა ატრიბუტების შემცველი ობიექტის მისაღებად.

#საპასუხო ობიექტის მაგალითი:

[
    {
        "id": "2xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "parent": "0xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "children": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
        "name": "{ORGANIZATION.names.short} Demo Child",
        "slug": "{ORGANIZATION.names.short}-demo-child",
        "config": {
            "emr_provider": "redox",
            "datascan": {
                "api": {
                    "token": ""
                }
            },
            "ldap": {
                "url": null,
                "bindDN": null,
                "bindCredentials": null,
                "searchBase": "",
                "adminGroupDN": "",
                "users": {
                    "class": "inetOrgPerson",
                    "subAttribute": "",
                    "usernameAttribute": ""
                },
                "groups": {
                    "class": "groupOfUniqueNames",
                    "idAttribute": "dn",
                    "nameAttribute": "cn",
                    "memberAttribute": "uniqueMember"
                }
            },
            "emr_provider_org": null,
            "logo": null,
            "pcc": {
                "clientId": "",
                "clientSecret": ""
            },
            "identity_provider": "amd",
            "azuread": {
                "client_id": "",
                "client_secret": "",
                "tenant": "",
                "admin_group": "",
                "npi_claim": "sub"
            },
            "agnes": {
                "whitelabel": "",
                "webPageTimeout": 15,
                "maxUsers": 2,
                "leftWindow": "medicalvideo",
                "rightWindow": null,
                "iframes": [],
                "modules": {
                    "chat": {
                        "enabled": true
                    },
                    "notes": {
                        "enabled": true,
                        "templates": []
                    },
                    "sessiondocs": {
                        "coverLogoHeight": 0,
                        "headerLogoHeight": 0
                    },
                    "vc": {
                        "enabled": true,
                        "force": false,
                        "iceTransportPolicy": "all"
                    },
                    "vitals": {
                        "enabled": true,
                        "temperatureUnits": "fahrenheit",
                        "bloodpressureUnits": "mmhg",
                        "heightUnits": "inches",
                        "weightUnits": "pounds"
                    }
                }
            },
            "identity_provider_org": null,
            "redox": {
                "destination_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "patient": {
                    "id_type": "EHRID"
                }
            }
        },
        "metadata": {
            "emr_provider": "redox",
            "emr_provider_org": null
        }
    },
    {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "parent": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "children": [],
        "name": "I am a sibling organization",
        "slug": "sibling",
        "config": {},
        "metadata": {
            "emr_provider": null,
            "emr_provider_org": null
        }
    },
    {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "parent": null,
        "children": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
        "name": "{ORGANIZATION.names.short} Demo",
        "slug": "{ORGANIZATION.names.short}-demo",
        "config": {
            "agnes": {
                "webPageTimeout": 1500,
                "maxUsers": 99,
                "modules": {
                    "notes": {
                        "templates": [
                            {
                                "template": "Telemedicine Patient Intake Form\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nLocal Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint/Reason for visit:   \n\nVital Signs   \n-SpO2: {{vitals.spo2}}      -Pulse: {{vitals.pulse}}   \n-Blood Pressure: {{vitals.bloodpressure}}   -Temperature: {{vitals.temperature}}   -Height: {{vitals.height}}   -Weight: {{vitals.weight}}   \n-Blood Glucose (mg/dL):    \n\nAdditional Encounter Notes:",
                                "name": "Patient Intake Form"
                            },
                            {
                                "template": "Telemedicine Provider Encounter Notes\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nObserving Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint of patient:\n\nDiagnosis:\n\nTreatment Plan:\n\nAdditional Encounter Notes:",
                                "name": "Provider Encounter Notes"
                            }
                        ]
                    },
                    "vitals": {
                        "temperatureUnits": "celsius"
                    }
                },
                "whitelabel": null,
                "iframes": [],
                "rightWindow": "videoconference",
                "leftWindow": "documents"
            },
            "logo": "url",
            "identity_provider": "amd",
            "emr_provider_org": "'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'",
            "identity_provider_org": "''",
            "emr_provider": "redox"
        },
        "metadata": {
            "emr_provider": "redox",
            "emr_provider_org": "'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'"
        }
    }
]

მეთოდი: მიიღეთ

{{baseUrl}}/api/v1/org?page=0

შეკითხვის პარამეტრები

პარამ	ღირებულება
გვერდი	0

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

ბოლო წერტილი: შექმენით ორგანიზაცია

გამოიყენეთ ეს API ახალი ორგანიზაციის შესაქმნელად.

მეთოდი: PUT

{{baseUrl}}/api/v1/org

სხეული (ნედლეული)

{
    "id": "{{$randomUUID}}",
    "name": "{{$randomAdjective}} {{$randomNoun}}",
    "slug": "{{$randomCatchPhraseNoun}}",
    "parent": "{{orgId}}",
    "config": {
        "agnes": {
            "webPageTimeout": 1500,
            "maxUsers": 99,
            "modules": {
                "notes": {
                    "templates": [
                        {
                            "template": "Telemedicine Patient Intake Form\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nLocal Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint/Reason for visit:   \n\nVital Signs   \n-SpO2: {{vitals.spo2}}      -Pulse: {{vitals.pulse}}   \n-Blood Pressure: {{vitals.bloodpressure}}   -Temperature: {{vitals.temperature}}   -Height: {{vitals.height}}   -Weight: {{vitals.weight}}   \n-Blood Glucose (mg/dL):    \n\nAdditional Encounter Notes:",
                            "name": "Patient Intake Form"
                        },
                        {
                            "template": "Telemedicine Provider Encounter Notes\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nObserving Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint of patient:\n\nDiagnosis:\n\nTreatment Plan:\n\nAdditional Encounter Notes:",
                            "name": "Provider Encounter Notes"
                        }
                    ]
                },
                "vitals": {
                    "temperatureUnits": "celsius"
                }
            },
            "whitelabel": null,
            "iframes": [],
            "rightWindow": "videoconference",
            "leftWindow": "documents"
        },
        "logo": "https://agnes-connect.s3.amazonaws.com/logos/04036433-63cf-4823-b222-af007005720b",
        "identity_provider": "amd",
        "emr_provider_org": "{{$randomUUID}}",
        "identity_provider_org": "{{$randomUUID}}",
        "emr_provider": "redox"
    },
    "metadata": {
        "emr_provider": "redox",
        "emr_provider_org": "{{$randomUUID}}"
    }
}

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

საბოლოო წერტილი: მიიღეთ ორგანიზაცია ID-ით

გამოიყენეთ ეს API, რომ მიიღოთ ობიექტი, რომელიც შეიცავს მონაცემებს მითითებული ორგანიზაციისთვის.

მეთოდი: მიიღეთ

{{baseUrl}}/api/v1/org/{{temporaryOrgId}}

პასუხი: 200

{
    "name": "1080p panel",
    "id": "9038420b-c49c-4b76-b87d-94052ba4c4df",
    "slug": "groupware",
    "config": {
        "logo": "https://agnes-connect.s3.amazonaws.com/logos/04036433-63cf-4823-b222-af007005720b"
    }
}

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

ბოლო წერტილი: ორგანიზაციის შეცვლა ID-ით

გამოიყენეთ ეს API მითითებული ორგანიზაციის მონაცემთა ატრიბუტების შესაცვლელად. მოთხოვნა ხდება ორგანიზაციის პირადობის მოწმობის გამოყენებით.

მეთოდი: PATCH

{{baseUrl}}/api/v1/org/{{temporaryOrgId}}

სხეული (ნედლეული)

{
    "id": "{{temporaryOrgId}}",
    "name": "{ORGANIZATION.names.short} Mod",
    "slug": "{ORGANIZATION.names.short}-mod"
}

პასუხი: 403

{
    "type": "ForbiddenError",
    "message": "Forbidden",
    "stack": "ForbiddenError: Forbidden\n    at assert (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/http-assert/index.js:8:9)\n    at patchOrganizations (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/api/v1/actions/organization/patch.js:24:9)\n    at runMicrotasks (<anonymous>)\n    at processTicksAndRejections (internal/process/task_queues.js:93:5)\n    at async nocacheMiddleware (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koajs-nocache/index.js:29:5)\n    at async bodyParser (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-bodyparser/index.js:95:5)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/api/v1/index.js:18:13\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:58:5\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/oidc-provider/lib/helpers/initialize_app.js:246:5\n    at async errorHandler (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/oidc-provider/lib/shared/error_handler.js:23:7)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n    at async serve (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-static/index.js:53:9)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/index.js:72:17\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-compress/index.js:43:5\n    at async logger (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-logger/index.js:67:7)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/index.js:49:13"
}

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

ბოლო წერტილი: წაშალე ორგანიზაცია ID-ით

გამოიყენეთ ეს API, რომ წაშალოთ მითითებული ორგანიზაცია მისი ID-ით.

მეთოდი: წაშლა

{{baseUrl}}/api/v1/org/{{temporaryOrgId}}

პასუხი: 204

null

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

საბოლოო წერტილი: მიიღეთ ორგანიზაცია Slug-ით

გამოიყენეთ ეს API, რომ მიიღოთ ობიექტი, რომელიც შეიცავს მითითებული ორგანიზაციის მონაცემთა ატრიბუტებს. მოთხოვნა შესრულებულია ორგანიზაციის შლაგის გამოყენებით.

მეთოდი: მიიღეთ

{{baseUrl}}/api/v1/org/slug/{{orgSlug}}

⁃ 3 3 ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ 3

უზრუნველყოფილია: postman-to-markdown