Supported DevRev object types for AirSync
Last updated: July 13, 2026
This document contains the list of all DevRev object types that are supported for AirSync.
Summary
| Object Type | Object Hierarchy | Loading | Extraction |
|---|---|---|---|
new_custom_object | custom_object | ✔︎ | ✔︎ |
account | account | ✔︎ | |
airdrop_platform_group | airdrop_platform_group | ✔︎ | |
article | article | ✔︎ | |
capability | part→capability | ✔︎ | ✔︎ |
channel | chat→channel | ✔︎ | |
comment | comment | ✔︎ | ✔︎ |
component | part→component | ✔︎ | ✔︎ |
conversation | conversation | ✔︎ | |
custom_link | link | ✔︎ | ✔︎ |
devu | dev_user | ✔︎ | |
directory | directory | ✔︎ | |
dm | chat→dm | ✔︎ | |
enhancement | part→enhancement | ✔︎ | ✔︎ |
feature | part→feature | ✔︎ | ✔︎ |
group | group | ✔︎ | |
incident | incident | ✔︎ | ✔︎ |
issue | work→issue | ✔︎ | ✔︎ |
link | link | ✔︎ | ✔︎ |
linkable | part→linkable | ✔︎ | ✔︎ |
meeting | meeting | ✔︎ | |
microservice | part→microservice | ✔︎ | ✔︎ |
object_member | object_member | ✔︎ | |
opportunity | work→opportunity | ✔︎ | ✔︎ |
product | part→product | ✔︎ | ✔︎ |
revu | rev_user | ✔︎ | |
runnable | part→runnable | ✔︎ | ✔︎ |
sprint | vista_group_item | ✔︎ | |
sprint_board | vista | ✔︎ | |
sysu | sys_user | ✔︎ | |
tag | tag | ✔︎ | |
task | work→task | ✔︎ | ✔︎ |
team | team | ✔︎ | |
ticket | work→ticket | ✔︎ | ✔︎ |
unified_authorization_policy | unified_authorization_policy | ✔︎ |
Key capabilities
| Capability | Description |
|---|---|
| Can Load | Indicates that the object type can be loaded into DevRev with AirSync. |
| Can Extract | Indicates that the object type can be synced out to external systems. |
| Can Subtype | Indicates that the object type supports subtype creation. |
| Can App Fragment | Indicates that the object type supports application fragments. |
new_custom_object
New custom object is an example of how custom objects look in the context of AirSync mapping.
Resource Type: custom_object
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | rich_text | Description of the object. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
title | text | Title of the object. |
account
Resource Type: account
Capabilities: Can App Fragment, Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
address | struct | Address of the Organization. | |
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | rich_text | Description of the corresponding Account. | |
display_name | text | ✔︎ | Name of the Organization. |
environment | enum | The environment of the Org. Defaults to 'production' if not specified. | |
external_refs | text (collection) | External refs are unique identifiers from your customer system of records, stored as a list. | |
industry | enum | Industry of the company. | |
item_url_field | text | Link to the item in the origin system. | |
lead_source | enum | The source that connected/introduced/referred the company. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
owned_by | reference (collection) → [#category:user] | ✔︎ | List of Dev user IDs owning this Account. |
phone_number | struct (collection) | Phone numbers of the Organization. | |
phone_numbers | text (collection) | Phone numbers of the Organization. | |
state | enum | ✔︎ | State of the Organization. |
tags | reference (collection) → [#record:tag] | Tags associated with an object. | |
tier | enum | The Tier of the corresponding Account. | |
total_revenue | int | Total sales revenue brought in by the company. | |
websites | text (collection) | Websites. |
Enum values
environment
| Value | Name | Description |
|---|---|---|
PRODUCTION | PRODUCTION | - |
STAGING | STAGING | - |
TEST | TEST | - |
industry
| Value | Name | Description |
|---|---|---|
accommodation_and_food_services | accommodation_and_food_services | - |
administrative_and_support_and_waste_management_and_remediation_services | administrative_and_support_and_waste_management_and_remediation_services | - |
agriculture_forestry_fishing_and_hunting | agriculture_forestry_fishing_and_hunting | - |
arts_entertainment_and_recreation | arts_entertainment_and_recreation | - |
construction | construction | - |
educational_services | educational_services | - |
finance_and_insurance | finance_and_insurance | - |
health_care_and_social_assistance | health_care_and_social_assistance | - |
information | information | - |
management_of_companies_and_enterprises | management_of_companies_and_enterprises | - |
manufacturing | manufacturing | - |
mining_quarrying_and_oil_and_gas_extraction | mining_quarrying_and_oil_and_gas_extraction | - |
other_services_except_public_administration | other_services_except_public_administration | - |
professional_scientific_and_technical_services | professional_scientific_and_technical_services | - |
public_administration | public_administration | - |
real_estate_and_rental_and_leasing | real_estate_and_rental_and_leasing | - |
retail_trade | retail_trade | - |
transportation_and_warehousing | transportation_and_warehousing | - |
utilities | utilities | - |
wholesale_trade | wholesale_trade | - |
lead_source
| Value | Name | Description |
|---|---|---|
direct_traffic | direct_traffic | - |
email_marketing | email_marketing | - |
employee_referral | employee_referral | - |
external_referral | external_referral | - |
offline_sources | offline_sources | - |
organic_search | organic_search | - |
organic_social | organic_social | - |
other | other | - |
other_campaigns | other_campaigns | - |
paid_search | paid_search | - |
paid_social | paid_social | - |
partner | partner | - |
partner_referral | partner_referral | - |
phone_inquiry | phone_inquiry | - |
public_relations | public_relations | - |
purchased_list | purchased_list | - |
referrals | referrals | - |
trade_show | trade_show | - |
web | web | - |
word_of_mouth | word_of_mouth | - |
state
| Value | Name | Description |
|---|---|---|
ACTIVE | ACTIVE | - |
INACTIVE | INACTIVE | - |
LOCKED | LOCKED | - |
tier
| Value | Name | Description |
|---|---|---|
tier_1 | tier_1 | - |
tier_2 | tier_2 | - |
tier_3 | tier_3 | - |
Structs
phone_number
| Field | Type | Required | Description |
|---|---|---|---|
e164_number | text | ✔︎ | The phone number in e164 format. |
extension | text | An optional extension. |
postal_address
| Field | Type | Required | Description |
|---|---|---|---|
country | text | Country name component. | |
formatted | text | Full mailing address, formatted for display or use on a mailing label. | |
locality | text | Town, city. | |
postal_code | text | Zip code of the address. | |
region | text | State, province, prefecture, or region component. | |
street_address | text | Full street address component. |
airdrop_platform_group
AirSync platform group object type is the representation of the default DevRev groups.
Resource Type: airdrop_platform_group
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
key | enum | ✔︎ | Key of the platform provided group. |
Enum values
key
| Value | Name | Description |
|---|---|---|
dev_users | Dev users | "Dynamic dev users group created by DevRev". |
none | No group | "No group selected". |
rev_users | Rev users | "Dynamic rev users group created by DevRev". |
article
Resource Type: article
Capabilities: Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
access_level | enum | Default access level for the object. | |
aliases | text (collection) | Aliases for the URL of the article. | |
applies_to_part_ids | reference (collection) → [#category:part] | Parts relevant to the article. | |
authored_by_ids | reference (collection) → [#category:user] | Users that authored the article. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | rich_text | Description of the article. | |
external_translation_group | text | The translation group the article belongs to. | |
extracted_plain_text | text | Extracted Plain Text. | |
item_url_field | text | Link to the item in the origin system. | |
language | text | Language of the article for i18n support. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
notify | bool | Whether to notify the user when the release notes are updated. | |
num_downvotes | int | Number of downvotes on the article. | |
num_upvotes | int | Number of upvotes on the article. | |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | Users that own the article. |
parent | reference → [#record:directory] | Parent of the article. | |
published_date | timestamp | Timestamp when the article was published. | |
release_notes | text | Release notes for the item. | |
resource | struct | The user visible resource of the article. It can either be rich text visible in DevRev or a URL to an article hosted outside of DevRev. | |
scope | enum | Scope of the article. | |
shared_with | permission (collection) | The list of Rev user, groups and dynamic groups with whom the article is shared and the corresponding roles. | |
status | enum | Status of the article. | |
tags | reference (collection) → [#record:tag] | Tags associated with the article. | |
title | text | ✔︎ | Title of the article. |
type | enum | Type of the article. | |
visible_to | enum |
Enum values
access_level
| Value | Name | Description |
|---|---|---|
EXTERNAL | - | - |
INTERNAL | - | - |
PRIVATE | - | - |
PUBLIC | - | - |
RESTRICTED | - | - |
scope
| Value | Name | Description |
|---|---|---|
1 | internal | - |
2 | external | - |
status
| Value | Name | Description |
|---|---|---|
archived | archived | - |
draft | draft | - |
published | published | - |
review_needed | review_needed | - |
type
| Value | Name | Description |
|---|---|---|
article | article | - |
content_block | content_block | - |
page | page | - |
visible_to
| Value | Name | Description |
|---|---|---|
customer_admins | - | - |
customers | - | - |
verified_customers | - | - |
Structs
resource
| Field | Type | Required | Description |
|---|---|---|---|
content | rich_text | Rich text content of the resource (relevant only for type devrev/rt). | |
type | enum | The type of resource. | |
url | text | URL of the resource (relevant only for type url). |
capability
Resource Type: part, capability
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
delivered_as | enum (collection) | Methods the product can be delivered as. | |
description | rich_text | Description of the part. | |
docs | struct (collection) | Docs associated with the part. | |
fulfilled_by | reference (collection) → [#category:part] | IDs of the runnables that fulfill this capability. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the part. |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the part. |
parent_part | reference → [#category:part] | ✔︎ | Parent of this part. |
parent_part_ids | reference (collection) → [#category:part] | Parent Part Ids of the Part. | |
pm_owner_id | reference → [#category:user] | User ID of the PM owner of the part. | |
ref_url | text | URL to the part details (git url, website, etc.). | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. |
Enum values
delivered_as
| Value | Name | Description |
|---|---|---|
goods | goods | - |
service | service | - |
software | software | - |
Structs
doc_field
| Field | Type | Required | Description |
|---|---|---|---|
doc_type | enum | Type of doc. | |
url_info | struct | ✔︎ | URL Info for the doc. |
url_field
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Title text for the url. | |
url | text | ✔︎ | URL for the field. |
channel
Resource Type: chat, channel
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
access_level | enum | The access level for the channel. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
last_comment_date | timestamp | Timestamp of the last comment in the chat. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | The name of the channel. If provided, this will be unique across all channels in the Dev org. It's case insensitive and must contain the characters [A-Za-z0-9_-]. | |
title | text | The title given to the chat. |
Enum values
access_level
| Value | Name | Description |
|---|---|---|
EXTERNAL | EXTERNAL | - |
INTERNAL | INTERNAL | - |
PRIVATE | PRIVATE | - |
PUBLIC | PUBLIC | - |
RESTRICTED | RESTRICTED | - |
UNKNOWN | UNKNOWN | - |
comment
Resource Type: comment
Capabilities: Can Extract, Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
body | rich_text | ✔︎ | Comment body. |
created_by_id | reference → [#category:user] | ✔︎ | User ID of the user that created the object. |
creator_display_name | text | Creator display name. | |
grandparent_object_id | reference → [#category:chat #category:custom_object #category:part #category:work #record:account #record:conversation #record:incident #record:meeting #record:revu] | The object this relates to. | |
grandparent_object_type | text | The object type this relates to. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | ✔︎ | User ID of the user that last modified the object. |
parent_object_id | reference → [#category:chat #category:custom_object #category:part #category:work #record:account #record:comment #record:conversation #record:incident #record:meeting #record:revu] | ✔︎ | The object this relates to. |
parent_object_type | text | The object type this relates to. | |
visibility | enum | Visibility of the comment. |
Enum values
visibility
| Value | Name | Description |
|---|---|---|
Visibility_EXTERNAL | Visibility_EXTERNAL | - |
Visibility_INTERNAL | Visibility_INTERNAL | - |
Visibility_PRIVATE | Visibility_PRIVATE | - |
Visibility_PUBLIC | Visibility_PUBLIC | - |
component
Resource Type: part, component
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
delivered_as | enum (collection) | Methods the product can be delivered as. | |
description | rich_text | Description of the part. | |
development_owner_id | reference → [#category:user] | User ID of the development owner of the part. | |
docs | struct (collection) | Docs associated with the part. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the part. |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the part. |
parent_part | reference → [#category:part] | Parent of this part. | |
parent_part_ids | reference (collection) → [#category:part] | Parent Part Ids of the Part. | |
pm_owner_id | reference → [#category:user] | User ID of the PM owner of the part. | |
qa_owner_id | reference → [#category:user] | User ID of the QA owner of the part. | |
ref_url | text | URL to the part details (git url, website, etc.). | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. |
Enum values
delivered_as
| Value | Name | Description |
|---|---|---|
goods | goods | - |
service | service | - |
software | software | - |
Structs
doc_field
| Field | Type | Required | Description |
|---|---|---|---|
doc_type | enum | Type of doc. | |
url_info | struct | ✔︎ | URL Info for the doc. |
url_field
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Title text for the url. | |
url | text | ✔︎ | URL for the field. |
conversation
Resource Type: conversation
Capabilities: Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
account_id | reference → [#record:account] | Globally unique ID for a DevRev account. | |
actual_close_date | timestamp | Timestamp when the conversation was actually completed. | |
ai_resolution_status | enum | Status of the AI resolution for the conversation. | |
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
applies_to_part_ids | reference (collection) → [#category:part] | Details of the parts relevant to the conversation. | |
broadcast_channels | text (collection) | Active channels for the conversation. | |
channels | reference (collection) → [#record:external_communication_channel] | Channel IDs of the conversation. | |
channels_instances | reference (collection) → [#record:external_communication_channel_instance] | Channel instance IDs of the conversation. | |
conversation_type | enum | ✔︎ | A type of object used to track conversations. |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | rich_text | Description of the conversation object. | |
first_response_time | timestamp | Timestamp to track the first response from Dev. | |
first_unreplied_rev_message_date | timestamp | First unreplied customer message's timestamp. | |
group | reference → [#record:group] | Group that owns the conversation. | |
is_creator_verified | bool | Whether the conversation is created by verified user. | |
is_spam | bool | Whether the conversation is spam. | |
last_external_message_date | timestamp | Timestamp of the last message in external discussion. | |
last_external_message_id | reference → [#record:comment] | ID of the last message in external discussion. | |
last_internal_message_date | timestamp | Timestamp of the last message in internal discussions. | |
last_internal_message_id | reference → [#record:comment] | ID of the last message in internal discussion. | |
last_message_id | reference → [#record:comment] | ID of the last message on the object. | |
last_message_timestamp | timestamp | Timestamp of the last message in the conversation. | |
member_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users in the conversation. |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
owned_by_ids | reference (collection) → [#category:user] | Users that own the conversation. | |
participant_oids | reference (collection) → [#record:account] | Globally unique IDs of participating orgs. | |
participant_uids | reference (collection) → [#category:user] | Globally unique ID of DevRev rev users. | |
priority | enum | Priority of the conversation. | |
sentiment | enum | Sentiment of the object. | |
sentiment_modified_date | timestamp | Timestamp when the sentiment was last modified. | |
sentiment_summary | text | Summary justifying the sentiment. | |
source_channel | text | Source channel for the conversation. | |
stage | enum | Stage of the conversation. | |
started_by_id | reference → [#category:user] | User that started the conversation. | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. | |
title | text | Title of the conversation object. | |
turing_active | bool | Whether Turing is active on the conversation. Will be true when Turing is active and false when it stops responding or when a dev user responds to the conversation. |
Enum values
ai_resolution_status
| Value | Name | Description |
|---|---|---|
1 | deflected | - |
2 | escalated | - |
conversation_type
| Value | Name | Description |
|---|---|---|
support | Support | - |
priority
| Value | Name | Description |
|---|---|---|
P0 | P0 | - |
P1 | P1 | - |
P2 | P2 | - |
stage
| Value | Name | Description |
|---|---|---|
archived | Archived | - |
hold | Hold | - |
needs_response | Needs Response | - |
new | New | - |
resolved | Resolved | - |
suspended | Suspended | - |
waiting_on_user | Waiting On User | - |
custom_link
Resource Type: link
Capabilities: Can Extract, Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
link_type_id | enum | ✔︎ | Link Type. |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
source_id | reference → [#category:custom_object #record:account #record:article #record:capability #record:conversation #record:enhancement #record:feature #record:incident #record:issue #record:meeting #record:opportunity #record:product #record:project #record:revu #record:task #record:ticket] | ✔︎ | Source object ID. |
target_id | reference → [#category:custom_object #record:account #record:article #record:capability #record:conversation #record:enhancement #record:feature #record:incident #record:issue #record:meeting #record:opportunity #record:product #record:project #record:revu #record:task #record:ticket] | ✔︎ | Target object ID. |
Enum values
link_type_id
| Value | Name | Description |
|---|---|---|
is_dependent_on | Is Dependent On | - |
is_duplicate_of | Is Duplicate Of | - |
is_parent_of | Is Parent Of | - |
is_related_to | Is Related To | - |
devu
Resource Type: dev_user
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
display_name | text | ✔︎ | The user's display name. The name is non-unique and mutable. |
email | text | Email address of the user. | |
full_name | text | Full name of the user. |
Structs
external_identity
| Field | Type | Required | Description |
|---|---|---|---|
display_name | text | Display name of the user in the external source. | |
id | text | ✔︎ | Unique ID of the user in the external source. |
issuer | text | ✔︎ | Issuer of the external identity of the user. |
state | enum | ✔︎ | State of the user in the external source. |
directory
Resource Type: directory
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | text | Description of the directory. | |
external_translation_group | text | The translation group the directory belongs to. | |
icon | text | Icon of the directory. | |
language | text | Language of the directory. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
parent | reference → [#record:directory] | Parent directory. | |
published | bool | ✔︎ | Whether the directory is published. |
shared_with | permission (collection) | The list of users and groups the directory is shared with and the corresponding roles. | |
tags | reference (collection) → [#record:tag] | Tags associated with the directory. | |
title | text | ✔︎ | Title of the directory. |
dm
Resource Type: chat, dm
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
is_default | bool | Whether this is the default DM for messaging the constituent users. If true, then this DM is always returned when opening a DM for the users. Note only one DM may be the default for a given set of users. | |
item_url_field | text | Link to the item in the origin system. | |
last_comment_date | timestamp | Timestamp of the last comment in the chat. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
record_ids | text (collection) | The associated records for this DM. | |
shared_with | permission (collection) | Members that this object is shared with. | |
title | text | The title given to the chat. | |
user_ids | reference (collection) → [#category:user #record:group] | ✔︎ | The users in the direct message. Only these users have access the chat's history and can send new messages (either users or groups). |
enhancement
Resource Type: part, enhancement
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
account_ids | reference (collection) → [#record:account] | Accounts associated to enhancement. | |
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
delivered_as | enum (collection) | Methods the product can be delivered as. | |
description | rich_text | Description of the part. | |
docs | struct (collection) | Docs associated with the part. | |
health | enum | Health status tracking for enhancement. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the part. |
opportunity_ids | reference (collection) → [#category:work] | Opportunities from the enhancement. | |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the part. |
parent_part | reference → [#category:part] | ✔︎ | Parent of this part. |
parent_part_ids | reference (collection) → [#category:part] | Parent Part Ids of the Part. | |
potential_revenue | float | Potential revenue from the enhancement. | |
ref_url | text | URL to the part details (git url, website, etc.). | |
release_notes | text | Release notes of the enhancement. | |
rev_score | float | Rev Score of the enhancement. | |
rev_score_tier | enum | Rev Score tier of the enhancement. | |
stage | enum | ✔︎ | Stage of the part. |
status_update | text | Status update for enhancement. | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. | |
target_close_date | timestamp | Target close date for the object. | |
target_start_date | timestamp | Target start date for the object. | |
team_id | reference → [#record:team] | The team associated with the object. | |
ticket_ids | reference (collection) → [#category:work] | Tickets associated with the enhancement. |
Enum values
delivered_as
| Value | Name | Description |
|---|---|---|
goods | goods | - |
service | service | - |
software | software | - |
health
| Value | Name | Description |
|---|---|---|
1 | On Track | - |
2 | At Risk | - |
3 | Off Track | - |
4 | Not Applicable | - |
rev_score_tier
| Value | Name | Description |
|---|---|---|
high | high | - |
low | low | - |
medium | medium | - |
stage
| Value | Name | Description |
|---|---|---|
deprecated | Deprecated | - |
deprioritized | Deprioritized | - |
general_availability | General Availability | - |
ideation | Ideation | - |
in_development | In Development | - |
in_testing | In testing | - |
limited_availability | Limited Availability | - |
prioritized | Prioritized | - |
ux_design | UX Design | - |
wont_do | Won't do | - |
Structs
doc_field
| Field | Type | Required | Description |
|---|---|---|---|
doc_type | enum | Type of doc. | |
url_info | struct | ✔︎ | URL Info for the doc. |
url_field
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Title text for the url. | |
url | text | ✔︎ | URL for the field. |
feature
Resource Type: part, feature
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
api_endpoints | struct (collection) | Associated API endpoints. | |
api_parameters_summary | text (collection) | Associated API parameters. | |
api_prefix_summary | text (collection) | Common Path Denominators of the Api Operations. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
delivered_as | enum (collection) | Methods the product can be delivered as. | |
description | rich_text | Description of the part. | |
development_owner_id | reference → [#category:user] | User ID of the development owner of the part. | |
discoveryevidences | text (collection) | A evidences that the inferer were able to find that justify the inference outcome. | |
docs | struct (collection) | Docs associated with the part. | |
fulfilled_by | reference (collection) → [#category:part] | IDs of the runnables that fulfill this feature. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the part. |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the part. |
parent_part | reference → [#category:part] | ✔︎ | Parent of this part. |
parent_part_ids | reference (collection) → [#category:part] | Parent Part Ids of the Part. | |
pm_owner_id | reference → [#category:user] | User ID of the PM owner of the part. | |
qa_owner_id | reference → [#category:user] | User ID of the QA owner of the part. | |
ref_url | text | URL to the part details (git url, website, etc.). | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. |
Enum values
delivered_as
| Value | Name | Description |
|---|---|---|
goods | goods | - |
service | service | - |
software | software | - |
Structs
api_endpoint
| Field | Type | Required | Description |
|---|---|---|---|
api_operations | struct | Operations associated with this API, such as the HTTP Verb, parameters, etc. | |
api_path | text | The URL of the API. | |
host | text | The Host of the API. |
api_operation
| Field | Type | Required | Description |
|---|---|---|---|
api_parameters | text | Parameters associated with the API operation. | |
api_path | text | The RestAPI path of the discovered API operation. | |
api_tags | text | Tags associated with the API operation, as defined in the api file. | |
fulfilled_by | reference | FulfilledBy IDs per API operation. | |
http_operation | enum | The Http verb of the discovered API operation. | |
locations | struct | Repo + file locations where the operation was detected. | |
name | text | Name of the API operation. |
doc_field
| Field | Type | Required | Description |
|---|---|---|---|
doc_type | enum | Type of doc. | |
url_info | struct | ✔︎ | URL Info for the doc. |
rev_location_summary
| Field | Type | Required | Description |
|---|---|---|---|
param_paths | text | The detailed path inside an OpenAPI file where information about this API object and its version were found. | |
repo_name | text | The name of the repo where information about this API object and its version were found. | |
repo_path | text | The repo path where information about this API object and its version were found. | |
source | text | The source where information about this API object and its version were found. |
url_field
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Title text for the url. | |
url | text | ✔︎ | URL for the field. |
group
Resource Type: group
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | rich_text | ✔︎ | Description of the group. |
includes | reference (collection) → [#record:group] | IDs of the group(s) that the group includes. | |
item_url_field | text | Link to the item in the origin system. | |
member_type | enum | Type of the members in the group. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the group. |
owner | reference → [#record:devu] | Owner of the group. | |
type | enum | Type of the group. |
Enum values
member_type
| Value | Name | Description |
|---|---|---|
dev_user | dev_user | - |
rev_user | rev_user | - |
svc_acc | svc_acc | - |
type
| Value | Name | Description |
|---|---|---|
dynamic | dynamic | - |
static | static | - |
incident
Resource Type: incident
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
acknowledged_date | timestamp | Timestamp when the incident was acknowledged. | |
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
applies_to_part_ids | reference (collection) → [#category:part] | Parts to which the work is attached. | |
body | rich_text | Body of the work object. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
identified_date | timestamp | Time when the incident was identified/reported. | |
item_url_field | text | Link to the item in the origin system. | |
mitigated_date | timestamp | Timestamp when the incident was mitigated. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
owned_by_ids | reference → [#category:user] | ✔︎ | User IDs of the users that own the work. |
pia_ids | reference (collection) → [#record:article] | The article ids of the Post-Incident Analysis(PIA) of the incident. | |
playbook_ids | reference (collection) → [#record:article] | The article ids of the playbook(s) associated with the incident. | |
related_doc_ids | reference (collection) → [#record:article] | The article ids of other documents associated with the incident. | |
reported_by | enum | The entity that first reported the incident. | |
severity | enum | ✔︎ | Severity of the work. |
stage | enum | ✔︎ | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. | |
target_close_date | timestamp | Timestamp when the work is expected to be complete. | |
title | text | ✔︎ | Title of the work object. |
Enum values
reported_by
| Value | Name | Description |
|---|---|---|
1 | Customer | - |
2 | Internal Users | - |
3 | System | - |
severity
| Value | Name | Description |
|---|---|---|
1 | sev-0 | - |
2 | sev-1 | - |
3 | sev-2 | - |
4 | sev-3 | - |
stage
| Value | Name | Description |
|---|---|---|
acknowledged | Acknowledged | - |
canceled | Canceled | - |
duplicate | Duplicate | - |
fixing | Fixing | - |
mitigated | Mitigated | - |
resolved | Resolved | - |
triage | Triage | - |
issue
Resource Type: work, issue
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
account_ids | reference (collection) → [#record:account] | Accounts associated to issues. | |
actual_close_date | timestamp | Timestamp when the work was actually completed. | |
actual_effort | float | Actual effort to complete the issue. | |
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
applies_to_part_id | reference → [#category:part] | ✔︎ | Details of the part relevant to the work. |
applies_to_version_ids | reference (collection) → [#record:version] | Part versions relevant to the work. | |
body | rich_text | Body of the work object. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
estimated_effort | float | Estimated effort to complete the issue. | |
fallback_parts | reference → [#category:part] | Other values that could serve as part if apples_to_part_id is found to be invalid. | |
item_url_field | text | Link to the item in the origin system. | |
last_code_activity | timestamp | Timestamp of the last code push (e.g. latest commit on all PRs with this issue). Note the Git-based snap-in populates this field, and should be installed in the org for auto-population. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the work. |
priority | enum | ✔︎ | Priority of the work based upon impact and criticality. |
release_version_ids | reference (collection) → [#record:version] | Versions that will contain the resolving commit IDs. | |
reported_by_ids | reference (collection) → [#category:user] | User IDs of the users that reported the work. | |
rev_org_ids | reference (collection) → [#record:account] | Rev orgs associated to issues. | |
sprint_id | reference → [#record:sprint] | Sprint to which the issue belongs. | |
sprint_state | enum | State of the sprint to which the issue belongs. | |
stage | enum | ✔︎ | Stage of the object. |
tags | reference (collection) → [#record:tag] | Tags associated with the object. | |
target_close_date | timestamp | Timestamp when the work is expected to be complete. | |
target_start_date | timestamp | Target start date for the object. | |
team_id | reference → [#record:team] | The team associated with the object. | |
title | text | ✔︎ | Title of the work object. |
Enum values
priority
| Value | Name | Description |
|---|---|---|
P0 | P0 | - |
P1 | P1 | - |
P2 | P2 | - |
P3 | P3 | - |
sprint_state
| Value | Name | Description |
|---|---|---|
active | active | - |
completed | completed | - |
planned | planned | - |
stage
| Value | Name | Description |
|---|---|---|
backlog | Backlog | - |
completed | Completed | - |
duplicate | Duplicate | - |
in_deployment | In Deployment | - |
in_development | In Development | - |
in_review | In Review | - |
in_testing | In Testing | - |
prioritized | Prioritized | - |
triage | Triage | - |
wont_fix | Won't Fix | - |
link
Resource Type: link
Capabilities: Can Extract, Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
link_type | enum | ✔︎ | Type of link used to define the relationship. |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
source_id | reference → [#category:work #record:incident] | ✔︎ | Source object ID. |
source_object_type | enum | Source object type. | |
target_id | reference → [#category:work #record:incident] | ✔︎ | Target object ID. |
target_object_type | enum | Target object type. | |
transformed_from_id | text |
Enum values
link_type
| Value | Name | Description |
|---|---|---|
is_dependent_on | Is Dependent On | - |
is_duplicate_of | Is Duplicate Of | - |
is_parent_of | Is Parent Of | - |
is_related_to | Is Related To | - |
source_object_type
| Value | Name | Description |
|---|---|---|
conversation | - | - |
incident | - | - |
work | - | - |
target_object_type
| Value | Name | Description |
|---|---|---|
conversation | - | - |
incident | - | - |
work | - | - |
linkable
Resource Type: part, linkable
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
coderepo_paths | text | Paths in the repository for the code part. | |
coderepo_url | text | URL to the server & repo for the code part. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
delivered_as | enum (collection) | Methods the product can be delivered as. | |
description | rich_text | Description of the part. | |
discoveryevidences | text (collection) | A evidences that the inferer were able to find that justify the inference outcome. | |
docs | struct (collection) | Docs associated with the part. | |
item_url_field | text | Link to the item in the origin system. | |
kind | enum | The kind of linkable. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the part. |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the part. |
parent_part | reference → [#category:part] | Parent of this part. | |
parent_part_ids | reference (collection) → [#category:part] | Parent Part Ids of the Part. | |
ref_url | text | URL to the part details (git url, website, etc.). | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. |
Enum values
delivered_as
| Value | Name | Description |
|---|---|---|
goods | goods | - |
service | service | - |
software | software | - |
kind
| Value | Name | Description |
|---|---|---|
component | component | - |
library | library | - |
Structs
doc_field
| Field | Type | Required | Description |
|---|---|---|---|
doc_type | enum | Type of doc. | |
url_info | struct | ✔︎ | URL Info for the doc. |
url_field
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Title text for the url. | |
url | text | ✔︎ | URL for the field. |
meeting
Resource Type: meeting
Capabilities: Can App Fragment, Can Extract, Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | ✔︎ | The channel of meeting. |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | rich_text | Description of the meeting. | |
ended_date | timestamp | Time at which meeting ended. | |
engagement_new_ref | text | Reference ID associated with the new engagement. | |
external_ref_id | text | External reference of the meeting. This is the identifier from the meeting channel/provider. | |
external_ref_ids | text (collection) | External reference IDs associated with the meeting. | |
external_url | text | External URL associated with the meeting. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
organizer_id | reference → [#category:user #record:group] | ✔︎ | ID of the organizer of the meeting. |
parent_id | reference → [#category:work #record:account] | Parent ID of the meeting. | |
parent_object_type | enum | Parent Objet Type. | |
participants | participation (collection) | ✔︎ | Represents the participants (devu/revu/group) of the meeting. |
recording_url | text | Recording URL of the meeting. | |
scheduled_date | timestamp | Time at which meeting was scheduled to start. | |
source_date | timestamp | The original source timestamp used for display. | |
state | enum | ✔︎ | The state of meeting. |
tags | reference (collection) → [#record:tag] | Tags associated with the meeting. | |
title | text | Title of the meeting object. | |
transcript_article_id | reference → [#record:article] | ID of the article for the transcript of the meeting. | |
visibility | enum | The visibility of the object. If 'internal', the object is visible within the Dev organization. If 'external', it is visible to both the Dev organization and Rev users. If 'private', only the users with whom the object is shared with will have the access. If not set, the default visibility is 'external'. |
Enum values
channel
| Value | Name | Description |
|---|---|---|
amazon_connect | amazon_connect | - |
devrev | devrev | - |
google_meet | google_meet | - |
offline | offline | - |
other | other | - |
teams | teams | - |
zoom | zoom | - |
parent_object_type
| Value | Name | Description |
|---|---|---|
account | - | - |
work | - | - |
state
| Value | Name | Description |
|---|---|---|
canceled | canceled | - |
completed | completed | - |
no_show | no_show | - |
ongoing | ongoing | - |
rejected | rejected | - |
rescheduled | rescheduled | - |
scheduled | scheduled | - |
waiting | waiting | - |
visibility
| Value | Name | Description |
|---|---|---|
1 | internal | - |
2 | external | - |
3 | private | - |
microservice
Resource Type: part, microservice
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
delivered_as | enum (collection) | Methods the product can be delivered as. | |
description | rich_text | Description of the part. | |
development_owner_id | reference → [#category:user] | User ID of the development owner of the part. | |
docs | struct (collection) | Docs associated with the part. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the part. |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the part. |
parent_part | reference → [#category:part] | Parent of this part. | |
parent_part_ids | reference (collection) → [#category:part] | Parent Part Ids of the Part. | |
pm_owner_id | reference → [#category:user] | User ID of the PM owner of the part. | |
qa_owner_id | reference → [#category:user] | User ID of the QA owner of the part. | |
ref_url | text | URL to the part details (git url, website, etc.). | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. |
Enum values
delivered_as
| Value | Name | Description |
|---|---|---|
goods | goods | - |
service | service | - |
software | software | - |
Structs
doc_field
| Field | Type | Required | Description |
|---|---|---|---|
doc_type | enum | Type of doc. | |
url_info | struct | ✔︎ | URL Info for the doc. |
url_field
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Title text for the url. | |
url | text | ✔︎ | URL for the field. |
object_member
Resource Type: object_member
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
add_member_ids | reference (collection) → [#category:user #record:group] | Add or update user IDs in the group. | |
airsync_role | enum | User's access level on the target item. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
member_id | reference → [#category:user #record:group] | ID of the user or group. | |
member_rev_oid | reference → [#record:account] | The unique ID of the member's Rev Organization. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
object_id | reference → [#category:custom_object #category:work #record:article #record:group #record:team] | ✔︎ | Globally unique DevRev Object Name (DON) for the object where the member is being added. |
remove_member_ids | reference (collection) → [#category:user #record:group] | Remove user IDs from the group. | |
target_object_type | enum | ✔︎ | Type of target object. |
valid_from_date | timestamp | Timestamp when this membership is valid. | |
valid_to_date | timestamp | Timestamp when this membership expires. |
Enum values
airsync_role
| Value | Name | Description |
|---|---|---|
edit_access | Editor | - |
read_access | Viewer | - |
target_object_type
| Value | Name | Description |
|---|---|---|
group | - | - |
dashboard | - | - |
work | - | - |
article | - | - |
custom_object | - | - |
account | - | - |
team | - | - |
opportunity
Resource Type: work, opportunity
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
account_id | reference → [#record:account] | ID of the account that the opportunity is related to. | |
actual_close_date | timestamp | Timestamp when the work was actually completed. | |
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
annual_contract_value | struct | Annual contract value of the opportunity. | |
body | rich_text | Body of the work object. | |
budget | struct | Budget of the opportunity. | |
contact_ids | reference (collection) → [#record:revu] | Contacts involved in the opportunity. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
fallback_parts | reference → [#category:part] | Other values that could serve as part if apples_to_part_id is found to be invalid. | |
forecast_category | enum | ✔︎ | Forecast category of the opportunity. |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the work. |
priority | enum | ✔︎ | Priority of the opportunity. |
probability | float | Probability of winning the deal, value lies between 0.0% and 100.0%. | |
reported_by_ids | reference (collection) → [#category:user] | User IDs of the users that reported the work. | |
stage | enum | ✔︎ | Stage of the object. |
tags | reference (collection) → [#record:tag] | Tags associated with the object. | |
target_close_date | timestamp | Timestamp when the work is expected to be complete. | |
title | text | ✔︎ | Title of the work object. |
value | struct | Value of the opportunity. |
Enum values
forecast_category
| Value | Name | Description |
|---|---|---|
commit | commit | - |
omitted | omitted | - |
pipeline | pipeline | - |
strong_upside | strong_upside | - |
upside | upside | - |
won | won | - |
priority
| Value | Name | Description |
|---|---|---|
P0 | P0 | - |
P1 | P1 | - |
P2 | P2 | - |
P3 | P3 | - |
stage
| Value | Name | Description |
|---|---|---|
closed_lost | Closed Lost | - |
closed_won | Closed Won | - |
contract | Contract | - |
negotiation | Negotiation | - |
qualification | Qualification | - |
stalled | Stalled | - |
validation | Validation | - |
Structs
money
| Field | Type | Required | Description |
|---|---|---|---|
amount | text | ✔︎ | Amount of the money. |
currency | text | ✔︎ | Currency of the money. |
product
Resource Type: part, product
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
delivered_as | enum (collection) | Methods the product can be delivered as. | |
description | rich_text | Description of the part. | |
docs | struct (collection) | Docs associated with the part. | |
fulfilled_by | reference (collection) → [#category:part] | IDs of the runnables that fulfill this product. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the part. |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the part. |
parent_part_ids | reference (collection) → [#category:part] | Parent Part Ids of the Part. | |
pm_owner_id | reference → [#category:user] | User ID of the PM owner of the part. | |
product_delivered_as | enum | Product Delivered as. | |
ref_url | text | URL to the part details (git url, website, etc.). | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. |
Enum values
delivered_as
| Value | Name | Description |
|---|---|---|
goods | goods | - |
service | service | - |
software | software | - |
product_delivered_as
| Value | Name | Description |
|---|---|---|
goods | goods | - |
service | service | - |
Structs
doc_field
| Field | Type | Required | Description |
|---|---|---|---|
doc_type | enum | Type of doc. | |
url_info | struct | ✔︎ | URL Info for the doc. |
url_field
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Title text for the url. | |
url | text | ✔︎ | URL for the field. |
revu
Resource Type: rev_user
Capabilities: Can App Fragment, Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
associations | reference (collection) → [#record:account] | List of Accounts that the Rev user is associated with. | |
browser | text | Browser name and version of the user. | |
browser_language | text | Language of browser of the user. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | rich_text | Description of the Rev user. | |
display_name | text | ✔︎ | The user's display name. The name is non-unique and mutable. |
email | text | Email address of the user. | |
external_refs | text (collection) | External refs are mutable unique identifiers for a contact record. If none are available, a good alternative is the email address(es)/phone number(s) which could uniquely identify the contact. If no identifier is specified, a system-generated identifier will be assigned to the contact. For organizations with multi-association contacts support enabled, this field accepts multiple identifiers, where each identifier must be unique across your DevOrg. For organizations without multi-association contacts support, this field accepts a single identifier, maintaining functionality consistent with the existing external_uid field. | |
external_uid | text | External ref is a mutable unique identifier for a user within the Rev organization from your primary customer record. If none is available, a good alternative is the email address/phone number which could uniquely identify the user. If none is specified, a system-generated identifier will be assigned to the user. | |
full_name | text | Full name of the user. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
phone_numbers | text (collection) | Phone numbers of the user. | |
plug_availability | enum | Status of the user on the PLuG. | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. |
Enum values
plug_availability
| Value | Name | Description |
|---|---|---|
offline | offline | - |
online | online | - |
runnable
Resource Type: part, runnable
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
coderepo_paths | text | Paths in the repository for the code part. | |
coderepo_url | text | URL to the server & repo for the code part. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
delivered_as | enum (collection) | Methods the product can be delivered as. | |
description | rich_text | Description of the part. | |
discoveryevidences | text (collection) | A evidences that the inferer were able to find that justify the inference outcome. | |
docs | struct (collection) | Docs associated with the part. | |
item_url_field | text | Link to the item in the origin system. | |
kind | enum | The kind of runnable. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the part. |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the part. |
parent_part | reference → [#category:part] | Parent of this part. | |
parent_part_ids | reference (collection) → [#category:part] | Parent Part Ids of the Part. | |
ref_url | text | URL to the part details (git url, website, etc.). | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. |
Enum values
delivered_as
| Value | Name | Description |
|---|---|---|
goods | goods | - |
service | service | - |
software | software | - |
kind
| Value | Name | Description |
|---|---|---|
ecr_image | ecr_image | - |
lambda | lambda | - |
microservice | microservice | - |
service | service | - |
Structs
doc_field
| Field | Type | Required | Description |
|---|---|---|---|
doc_type | enum | Type of doc. | |
url_info | struct | ✔︎ | URL Info for the doc. |
url_field
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Title text for the url. | |
url | text | ✔︎ | URL for the field. |
sprint
Resource Type: vista_group_item
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
end_date | timestamp | ✔︎ | Timestamp when the sprint ends. |
goals | text | Goals of the sprint. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the sprint. |
parent_id | reference → [#record:sprint_board] | ✔︎ | Parent sprint board of the sprint. |
start_date | timestamp | ✔︎ | Timestamp when the sprint starts. |
sprint_board
Resource Type: vista
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
cooldown | int | Cooldown period in days between sprints. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | rich_text | Description of the sprint board. | |
duration | int | Duration of the sprints belonging to this sprint board in days. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the sprint board. |
planned_sprints | int | Number of planned sprints for the sprint board. | |
team_id | reference → [#record:team] | The team associated with the object. |
sysu
Resource Type: sys_user
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
display_name | text | ✔︎ | The user's display name. The name is non-unique and mutable. |
full_name | text | Full name of the user. |
tag
Resource Type: tag
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
access_level | enum | Access level for the tag. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | rich_text | Description of the tag. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the tag. |
style | text | hex color of in the format #RRGGBB. |
Enum values
access_level
| Value | Name | Description |
|---|---|---|
internal | internal | - |
private | private | - |
public | public | - |
restricted | restricted | - |
task
Resource Type: work, task
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
actual_close_date | timestamp | Timestamp when the work was actually completed. | |
actual_effort | float | Actual effort to complete the task. | |
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
applies_to_part_id | reference → [#category:part] | Details of the part relevant to the work. | |
applies_to_version_ids | reference (collection) → [#record:version] | Part versions relevant to the work. | |
body | rich_text | Body of the work object. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
embedded | bool | Whether this task is an embedded task of another work or not. | |
estimated_effort | float | Estimated effort to complete the task. | |
fallback_parts | reference → [#category:part] | Other values that could serve as part if apples_to_part_id is found to be invalid. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the work. |
priority | enum | Priority of the work based upon impact and criticality. | |
reported_by_ids | reference (collection) → [#category:user] | User IDs of the users that reported the work. | |
stage | enum | ✔︎ | Stage of the object. |
start_date | timestamp | Timestamp when the task was started. | |
tags | reference (collection) → [#record:tag] | Tags associated with the object. | |
target_close_date | timestamp | Timestamp when the work is expected to be complete. | |
title | text | ✔︎ | Title of the work object. |
Enum values
priority
| Value | Name | Description |
|---|---|---|
P0 | P0 | - |
P1 | P1 | - |
P2 | P2 | - |
P3 | P3 | - |
stage
| Value | Name | Description |
|---|---|---|
in_development | In Development | - |
open | Open | - |
resolved | Resolved | - |
team
Resource Type: team
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
description | text | The description of the team. | |
key | text | ✔︎ | Key for uniquely identifying the team. |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
name | text | ✔︎ | Name of the team. Shall be derived from the group name associated with the team's space. |
parent_id | reference → [#record:team] | The parent of the team. |
ticket
Resource Type: work, ticket
Capabilities: Can Extract, Can Load, Can Subtype
Fields
| Field | Type | Required | Description |
|---|---|---|---|
account_id | reference → [#record:account] | Globally unique ID for a DevRev account. | |
actual_close_date | timestamp | Timestamp when the work was actually completed. | |
airsync_shared_with | permission (collection) | List of users and groups who have explicit access to the item and the corresponding roles. | |
applies_to_part_id | reference → [#category:part] | ✔︎ | Details of the part relevant to the work. |
applies_to_version_ids | reference (collection) → [#record:version] | Part versions relevant to the work. | |
body | rich_text | Body of the work object. | |
channels | enum (collection) | Channels of the ticket. | |
channels_v2 | reference (collection) → [#record:external_communication_channel] | Channel IDs of the ticket. | |
channels_v2_instances | reference (collection) → [#record:external_communication_channel_instance] | Channel instance IDs of the ticket. | |
created_by_id | reference → [#category:user] | User ID of the user that created the object. | |
fallback_parts | reference → [#category:part] | Other values that could serve as part if apples_to_part_id is found to be invalid. | |
group | reference → [#record:group] | Group that owns the ticket. | |
is_spam | bool | Whether the ticket is spam. | |
item_url_field | text | Link to the item in the origin system. | |
modified_by_id | reference → [#category:user] | User ID of the user that last modified the object. | |
needs_response | bool | Whether the ticket needs a response. | |
owned_by_ids | reference (collection) → [#category:user] | ✔︎ | User IDs of the users that own the work. |
reported_by_ids | reference (collection) → [#category:user] | User IDs of the users that reported the work. | |
rev_oid | reference → [#record:account] | Globally unique ID for a DevRev rev org. | |
sentiment | enum | Sentiment of the object. | |
sentiment_modified_date | timestamp | Timestamp when the sentiment was last modified. | |
sentiment_summary | text | Summary justifying the sentiment. | |
severity | enum | ✔︎ | Severity of the ticket. |
stage | enum | ✔︎ | Stage of the object. |
tags | reference (collection) → [#record:tag] | Tags associated with the object. | |
target_close_date | timestamp | Timestamp when the work is expected to be complete. | |
title | text | ✔︎ | Title of the work object. |
visibility | enum | The visibility of the object. If 'internal', the object is visible within the Dev organization. If 'external', it is visible to both the Dev organization and Rev users. If 'private', only the users with whom the object is shared with will have the access. If not set, the default visibility is 'external'. |
Enum values
channels
| Value | Name | Description |
|---|---|---|
email | - | - |
plug | - | - |
slack | - | - |
severity
| Value | Name | Description |
|---|---|---|
blocker | Blocker | - |
high | High | - |
low | Low | - |
medium | Medium | - |
stage
| Value | Name | Description |
|---|---|---|
awaiting_customer_response | Awaiting Customer Response | - |
awaiting_development | Awaiting Development | - |
awaiting_product_assist | Awaiting Product Assist | - |
canceled | Canceled | - |
in_development | In Development | - |
queued | Queued | - |
resolved | Resolved | - |
work_in_progress | Work In Progress | - |
visibility
| Value | Name | Description |
|---|---|---|
1 | internal | - |
2 | external | - |
3 | private | - |
unified_authorization_policy
The authorization policy object is the intermediate object type for creating MFZ object types: role, role_set, and access_control_entry.
Resource Type: unified_authorization_policy
Capabilities: Can Load
Fields
| Field | Type | Required | Description |
|---|---|---|---|
conditional_access | conditional_privilege (collection) | Fields or objects and privileges the role applies to if the defined conditions are met. | |
field_access | field_privilege (collection) | Fields and privileges the role applies to. | |
groups | reference (collection) → [#record:airdrop_platform_group #record:group] | Groups this role applies to. | |
name | text | The name of the authorization policy instance. | |
object_access | record_type_privilege (collection) → [#category:custom_object #category:part #category:work #record:article #record:conversation #record:incident] | ✔︎ | Privileges and objects the role applies to. |
users | reference (collection) → [#record:devu #record:revu] | Users this role applies to. |
Last updated on