Culture Resource¶
Get Culture By ID¶
HTTP Request
GET /api/culture/{id}
📋 Description: Retrieves detailed information about a specific culture entry identified by the provided ID, enabling users to access relevant cultural insights and data for informed 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 "displayId": "string",
6 "name": "string",
7 "code": "string",
8 "isDefault": true,
9 "objectAvailable": true
10}
Update Culture¶
HTTP Request
PUT /api/culture/{id}
📋 Description: Updates the details of a specific culture entry identified by its unique ID, allowing for the modification of attributes to reflect current organizational values and practices.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated cultural attributes and associated metadata for the specified culture ID. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "code": "string",
8 "isDefault": true,
9 "objectAvailable": true
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Culture¶
HTTP Request
DELETE /api/culture/{id}
📋 Description: Deletes a specified culture entry from the system, ensuring the removal of outdated or irrelevant data to maintain accurate organizational culture records.
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 Cultures¶
HTTP Request
GET /api/culture
📋 Description: Fetches cultural insights and data relevant to organizational values and employee engagement, facilitating informed decision-making for enhancing workplace culture.
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 "displayId": "string",
7 "name": "string",
8 "code": "string",
9 "isDefault": true,
10 "objectAvailable": true
11 }
12]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing cultural attributes and values within an organization, facilitating the alignment of workforce initiatives with corporate identity and employee engagement strategies.] |
|
» 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 |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» code |
string |
false |
none |
Code identifier for the resource |
» isDefault |
boolean |
false |
none |
Whether the resource is default |
» objectAvailable |
boolean |
false |
none |
Indicates whether the cultural object is currently available for use within the system. |
Create Culture¶
HTTP Request
POST /api/culture
📋 Description: Creates a new culture entry within the system, enabling organizations to define and enhance their workplace culture initiatives.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the cultural initiative details, including objectives, target audience, and implementation timeline. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "code": "string",
8 "isDefault": true,
9 "objectAvailable": true
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Get Available Cultures¶
HTTP Request
GET /api/culture/available
📋 Description: Retrieves a list of available cultural resources within the organization, enabling users to assess and leverage cultural assets for enhanced employee engagement and organizational alignment.
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 "displayId": "string",
7 "name": "string",
8 "code": "string",
9 "isDefault": true,
10 "objectAvailable": true
11 }
12]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing cultural attributes and values within an organization, facilitating the alignment of workforce initiatives with corporate identity and employee engagement strategies.] |
|
» 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 |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» code |
string |
false |
none |
Code identifier for the resource |
» isDefault |
boolean |
false |
none |
Whether the resource is default |
» objectAvailable |
boolean |
false |
none |
Indicates whether the cultural object is currently available for use within the system. |