Getting started with custom objects
This is a continuing discussion about the article Getting started with custom objects in the developer documentation.
-
Hello Matt, to represent many-to-many relationships, you need to create multiple relationship types that go in both directions. Let me know if that doesn't work for you for some reason.
I'm not sure about the Insights question yet, someone will follow up about that.
-
Hello,
In this article, it is specified that a many-to-many relationship is possible, however I am not finding how. If I attempt to submit a request to the API to create a relation which I believe would handle that (source and target are arrays), I get returned an error saying "Cannot create a relationship type where both source and target are arrays".
Also, is there a feature request page for having Custom Resources loaded into Insights? That function could greatly benefit our company as well.
Thank you,
-
Jason,
I am not sure I follow. I know in an SQL database, I would have to use an intermediary table. Take the following example, if I want a many-to-many relationship between the Zendesk type ticket and a custom object named "location", I would have to do the following:
- Create the custom object type "location".
- Create a custom object type "location_ticket".
- Create a many-to-one relationship type from "location" to "location_ticket" named "location-has-many-location_ticket".
- Create a one-to-many relationship type from "location_ticket" to "location" named "location_ticket-belongs-to-location".
- Create a many-to-one relationship type from "zen:ticket" to "location_ticket" named "zen:ticket-has-many-location_ticket".
- Create a one-to-many relationship type from "location_ticket" to "zen:ticket" named "location_ticket-belongs-to-zen:ticket"
Then any time I want to associate a ticket to a location or an additional location, I would need to do the following:
- Create an object of type "location_ticket".
- Create a relationship of type "location-has-many-location_ticket" between the "location" and the "location_ticket".
- Create a relationship of type "location_ticket-belongs-to-location" the other direction between the "location" and the "location_ticket".
- Create a relationship of type "zen:ticket-has-many-location_ticket" between the ticket and the "location_ticket".
- Create a relationship of type "location_ticket-belongs-to-zen:ticket" the other direction between the ticket and the "location_ticket".
Can you let me know if I'm on the right track, or completely off base?
Thanks,
Matt
-
Hi Matt, I think you are on the right track, but I'm not sure you need the `location_ticket` object, unless it's holding additional properties about the relationship. You should be able to create a one-to-many relationship between location -> zen:ticket as well as a one-to-many relationship between zen:ticket -> location. Then when you need to associate a ticket to a location, you would create a ticket -> location relationship for the ticket, and a corresponding location -> ticket relationship if you want to know all tickets associated with a location.
-
Under Associating related objects it states:
"A relationship record is governed by a relationship type you created. So far you created a one-to-many type named "pc_has_many_tickets" where each ticket can be associated with only one PC, but each PC can be associated with many tickets."
I'm not seeing this behavior in my tests. The API will let me create multiple relationship records using different PC source IDs with the same "zen:ticket" target. The same applies if I define a one-to-one relationship type. It seems that the single or many schema only affects the number of targets a source can be linked to, but not vice versa. Is this true, or am I doing something wrong?
-
Hi Jason, when you create multiple relationships with different PC source IDs, you are creating *different* relationships for each PC. The same is true for one-to-one: each relationship is a separate relationship. The difference between one-to-one and one-to-many is that the target field in the one-to-many relationship type is an array. Whereas the target field in the one-to-one is a single ID.
You should not be able to create multiple relationships with the *same* PC source ID in either the one-to-one or the one-to-many example.
Does that help?
-
Hi Matthew,
I think you could achieve this using an app. I don't believe there is anything baked in that you could use.
More info on the ticket apps can be found here.
https://developer.zendesk.com/apps/docs/support-api/ticket_sidebar
You would basically want activate on the app.activated function to retrieve your list for the user and then populate the app with the data from the custom object that you want.
-
Hello,
How can I add a drop down to a ticket form and populate it with custom objects that are related to the requester. I created a ticket field and associated the custom objects to the employee, just have been struggling on how to populate the custom objects into the drop down.
Is this possible? -
Anyone have an example application that is pulling related Objects on a user?
url: '/api/sunshine/objects/records/zen:user:' + id + '/related/object_record_name',
-
Hi Matt,
Do you have a question about using our List Related Object Records API? You'll want to use the relationship type in the url to return related records. For example, my test account has a user_has_many_devices relationship type. The url I used to get a user's device objects was the following:
Best,
Chris -
Is there any way to access sunshine custom object data from within a ticket body - either via macro or preferably a placeholder?
-
@..., I don't think that's possible. You could write a custom app to insert text into the body of the editor but that would be the only way I know of to get it in there at this time. Sounds like a good idea though so you may want to put in a feature request.
-
How is custom object size determined..? it says 32kb in the documentation, how to find out if my custom object has reached this 32kb limit..?
-
Hey Prashanth,
The object size is determined by the actual byte size of the object being stored. An easy way to tell how large your object is to use postman and a search query for one object. Then you can see the object size by looking at the response body's size. For an example I've included the size of a response with 12 nested attributes (all strings) and an external id. As you can see, you'd need an absolutely massive custom object to come anywhere near this limit.
Hope this helps!
Eric -
Hi,
I need to add a "custom lookup relationship" field to my tickets referencing to a custom object. But it seems like I can only add one referencing to tickets, organizations or users. According to this article its possible as stated:
"One approach to building this app would be to add a dropdown list to the ticket form in Help Center that lets users select a PC when they submit a ticket."
But the instructions are unclear. Regardless of how many relationships I define, my custom object refuses to show up under the "related object" dropdown in when defining a custom lookup relationship field.
---------------------------------
---------------------------------
---------------------------------
---------------------------------
What am I missing here? -
Levente Nagy I think the issue is that you're trying to use lookup relationship fields with custom objects, but instead you need to be defining relationships between the objects either via the Relationships page in Admin Center or the API (https://developer.zendesk.com/documentation/custom-data/custom-objects/getting-started-with-custom-objects/#modeling-your-data).
-
Jacquelyn Brewer I'm having the same issue as Levente Nagy and I feel trapped in a vicous circle.
My use case: I run a website agency. I have clients (organizations) for whom I manage websites (one or more). Each site is either hosted on my server or externally.
My objective: I want to be able to see, under each organzation, which websites I manage for them and where they're hosted.
What I did:
- In the Admin Center, under Objects and rules > Custom objects > Objects I Createad a custom object called "website" with 2 properties: URL and external_hosting (checkbox).
- In the Admin Center, under Objects and rules > Custom objects > Relationships I Createad a relationship between website (source) > zen:organization (target).
- I even created the reverse relationship: zen:organization (source) > website (target).
What I tried to do then:
In the Admin Center, under People > Configuration > Organization fields, I tried to create a lookup field to manage the custom object records for the organization. I expected to be able to see my custom object available to select in that same dropbox marked in red in Levente Nagy's post.What are we missing, then?
What's the right way to manage relationships with custom object records in the interface? or is it just an API feature? If there is a way, please can you provide a detailed documentation, as the current articles you linked to are not helpful. -
Hi Itay,
Lookup fields are available as part of the new Custom Objects EAP. Have you signed up for the EAP?
-
Christopher Kennedy Just did, thanks.
Please sign in to leave a comment.
19 Comments