afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/WorkCoaching.json

53 lines
2.6 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"associated_objects"
],
"title": "WorkCoaching - Data API",
"description": "Represents a single coaching relationship between two users. One of the users is defined as the coach and the other is defined as a coachee. WorkCoaching is feed-enabled so there is a private feed available to the coach and coachee.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"CoachId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort, Update",
"description": "[Required] The coach in this 1:1 coaching relationship."
},
"CoachedId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort, Update",
"description": "[Required] The user being coached in this 1:1 coaching relationship."
},
"IsInactive": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the coaching relationship is Inactive (true) or not (false)."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The time stamp that indicates when the current user last viewed a record that is related to this coaching relationship."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The time stamp that indicates when the current user last viewed this coaching relationship. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "[Required] The records name. Max length is 255 characters."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "ID of the contact who owns the WorkCoaching record."
}
},
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **WorkCoachingFeed**: Feed tracking is available for the object.\n- **WorkCoachingHistory**: History is available for tracked fields of the object.\n- **WorkCoachingOwnerSharingRule**: The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see Phased WDC (legacy Work.com) Feature Retirement.\n- **WorkCoachingShare**: Sharing rules are available for the object."
}