Let’s look at the method Request tab and the request format.
If you added a method, you’ll be able to find which fields will be used in its request. So these are what are sent out from Cyclr to the API.
When adding a field you first enter how the field is described in the API.
Choose this connector field, let’s say the location is category. And within the object we have category on the side. So let’s say it’s value.
So what I’ve created now the bottom is a category value field that’s tied in with a Category A and Category ID. So it’s the same level same set of object.
Cyclr will then automatically set a system field internal use, and it will do its best to set an appropriate display name.
It’s usually a good idea to leave the system field as is. However, if you’re using multiple calls, or if it’s something generic like an ID, it’s better to name it along with the object.
So this ID here if and pet it in fact, the pet ID. Now when I’m using calls further down the line, if I get a pet ID returned from an external system, for example, Cyclr will automatically map those when it comes to setting up the Cycle.
I also have to choose the source. But when I choose the source, if a response fields system field is pet ID, then Cyclr automatically map it for you.
You can also give descriptions to these fields. Choose whether the field is hidden to the user, choose whether the field is optional or required by the requests. Set the data type and give it a default value.
You also have the option to set a number of field values, which the user can choose. But when they’re limited values for field and you can also choose a trigger.
So let’s say we have a pet ID and we have a list Pet ID method and I’ll touch upon this later, but I could set up a trigger that just pulls down the list of all those Pet IDs so that I can choose from that list which penalty I want to create.
If you have a number of fields to add that you have an example pay load, you can click Generate fields. demonstrate that to you. Now.
Let me just delete these.
And now what I want to do is click Generate fields here, paste in a payload, which is the same payload, this will generate all the same fields as before. And hit generate, Cyclr will automatically populate the fields, give them the appropriate names.
And then you’ll be able to use those within your requests within your methods.
If you need to edit multiple fields at once, say change the data type etc, you can just select multiple at a time.
Set selected fields to either be hidden optional or define a data type in these instances.
When your changes are done, hit save.