Official Procedure Resource¶
Get Official Procedure¶
HTTP Request
GET /api/officialProcedures/{id}
📋 Description: Retrieves detailed information about a specific official procedure identified by the provided ID, enabling users to access essential data for compliance and operational decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "description": "string"
7}
Update Official Procedure¶
HTTP Request
PUT /api/officialProcedures/{id}
📋 Description: Updates the details of a specific official procedure identified by the provided ID, ensuring that the latest information is accurately reflected in the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated details of the official procedure, including its title, description, status, and any relevant metadata for effective management and tracking. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "description": "string"
7}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Official Procedure¶
HTTP Request
DELETE /api/officialProcedures/{id}
📋 Description: Deletes a specified official procedure by its unique identifier, ensuring the removal of outdated or unnecessary records from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Official Procedures¶
HTTP Request
GET /api/officialProcedures
📋 Description: Retrieves a list of official procedures available within the system, enabling users to access and review compliance and operational guidelines.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "description": "string"
8 }
9]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an official procedure, encapsulating essential details and metadata necessary for compliance and operational efficiency within the organization.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
Create Official Procedure¶
HTTP Request
POST /api/officialProcedures
📋 Description: Submits new official procedures for approval, enabling organizations to streamline compliance and governance processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of the official procedures to be submitted, including relevant metadata and compliance information. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "description": "string"
7}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10