1
- Custom links allow you to create organization-specific relationships between any two objects in DevRev.
1
+ Links allow you to create organization-specific relationships between any two objects in DevRev.
2
2
This feature enables you to define meaningful connections with custom names that reflect your business processes.
3
3
4
- This section provides an overview of custom links and walks you through the process of creating and managing them.
4
+ This section provides an overview of links and walks you through the process of creating and managing them.
5
5
By the end of this section, you'll be able to:
6
- 1 . Define custom link types
6
+ 1 . Define link types
7
7
2 . Create links between objects
8
- 3 . List custom link types
9
- 4 . Update custom link types
10
- 5 . Deprecate custom link types
8
+ 3 . List link types
9
+ 4 . Update link types
10
+ 5 . Deprecate link types
11
11
12
12
## Concepts
13
13
14
- ### Custom link type
14
+ ### Link type
15
15
16
- A custom link type defines a relationship between two types of objects. It specifies:
16
+ A link type defines a relationship between two types of objects. It specifies:
17
17
- The source object types that the link initiates from
18
18
- The target object types that the link can be created to
19
19
- A forward name describing the relationship from source to target
20
20
- A backward name describing the relationship from target to source
21
21
22
22
### Supported object types
23
23
24
- Custom links can be created between the following object types:
24
+ Links can be created between the following object types:
25
25
- custom object
26
26
- issue, ticket, task, opportunity
27
27
- account, user
28
28
- part (product, capability, feature, enhancement)
29
29
30
30
For more details on customization or custom object concepts, please refer to the documentation below:
31
31
- [ Customization] ( ./object-customization )
32
- - [ Custom objects] ( ./custom-objects )
32
+ - [ Custom objects] ( ./custom-objects )
33
33
34
- ## Create custom link types
34
+ ## Create link types
35
35
36
36
<Callout intent = " note" >
37
37
Let's say you want to establish a parent-child relationship between tickets and a custom object
38
38
type called "Campaign". This relationship helps track which tickets are assigned to which campaigns.
39
39
</Callout >
40
40
41
- To create this relationship, make an API call to create a custom link type:
41
+ To create this relationship, make an API call to create a link type:
42
42
43
43
``` curl
44
44
curl --location 'https://api.devrev.ai/link-types.custom.create' \
@@ -63,7 +63,7 @@ curl --location 'https://api.devrev.ai/link-types.custom.create' \
63
63
}'
64
64
```
65
65
66
- The custom link type above defines:
66
+ The link type above defines:
67
67
- A descriptive name
68
68
- Source types that the link can be created from (ticket)
69
69
- Target types that the link can be created to (campaign custom object)
@@ -72,7 +72,7 @@ The custom link type above defines:
72
72
73
73
## Create links between objects
74
74
75
- Once you have defined a custom link type, you can create links between objects:
75
+ Once you have defined a link type, you can create links between objects:
76
76
77
77
``` curl
78
78
curl --location 'https://api.devrev.ai/links.create' \
@@ -87,15 +87,15 @@ curl --location 'https://api.devrev.ai/links.create' \
87
87
```
88
88
89
89
<Callout intent = " tip" >
90
- When creating a custom link:
90
+ When creating a link:
91
91
- Set ` link_type ` to ` "custom_link" `
92
- - Provide the custom link type ID in ` custom_link_type `
92
+ - Provide the link type ID in ` custom_link_type `
93
93
- Ensure both source and target objects exist to prevent dangling links
94
94
</Callout >
95
95
96
- ## List custom link types
96
+ ## List link types
97
97
98
- You can list custom link types in your organization, with optional filtering:
98
+ You can list link types in your organization, with optional filtering:
99
99
100
100
``` curl
101
101
curl --location 'https://api.devrev.ai/link-types.custom.list' \
@@ -111,14 +111,14 @@ curl --location 'https://api.devrev.ai/link-types.custom.list' \
111
111
}'
112
112
```
113
113
114
- ## Update custom link types
114
+ ## Update link types
115
115
116
116
<Callout intent = " note" >
117
117
Now, you want to expand the source types to allow both issues and tickets to have this relationship
118
118
with campaigns.
119
119
</Callout >
120
120
121
- You can update the existing custom link type to include additional source types:
121
+ You can update the existing link type to include additional source types:
122
122
123
123
``` curl
124
124
curl --location 'https://api.devrev.ai/link-types.custom.update' \
@@ -145,7 +145,7 @@ You may want to restrict links to specific subtypes of objects. For example, onl
145
145
of a particular subtype to be linked to tickets.
146
146
</Callout >
147
147
148
- Create a custom link type with subtype restrictions:
148
+ Create a link type with subtype restrictions:
149
149
150
150
``` curl {11}
151
151
curl --location 'https://api.devrev.ai/link-types.custom.create' \
@@ -178,14 +178,14 @@ This configuration:
178
178
To add more valid source subtypes, use the update endpoint to add them to the ` source_types ` array.
179
179
</Callout >
180
180
181
- ## Deprecate custom link types
181
+ ## Deprecate link types
182
182
183
183
<Callout intent = " note" >
184
- Custom link types cannot be deleted, only deprecated. This ensures that existing links maintain
184
+ Link types cannot be deleted, only deprecated. This ensures that existing links maintain
185
185
referential integrity and prevents data corruption.
186
186
</Callout >
187
187
188
- To deprecate a custom link type, use the update endpoint and set ` deprecated ` to ` true ` :
188
+ To deprecate a link type, use the update endpoint and set ` deprecated ` to ` true ` :
189
189
``` curl {6}
190
190
curl --location 'https://api.devrev.ai/link-types.custom.update' \
191
191
--header 'Content-Type: application/json' \
0 commit comments