You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

Resources

get

URL/api/v1/api.php?target=resource&action=get
DescriptionGet a resource or resources
ReturnsExamples:
SUCCESSFUL: {"success":1,"message":"Search successful","data":[{"id":"57","name":"2nd Email","slug":"6c-contact-email2","type":"field","parent_id":"1","category_id":null,"attr":[]}]}
ERROR: {"success":0,"message":"Search failed"}
Optional Parameters
NameTypeNotes/Example
nameSTRINGName of the resource. Example: 6Connect, Inc.
slugSTRINGThe unique URL friendly name of the resource. Example: 6connect-inc
typeSTRINGType of resource (eg. entry, field, category)

 

At most, one of the following:

NameTypeNotes/Example
idINTEGERGet the resource which has this ID
resource__inARRAYGet any resource which has any of these IDs
resource__not_inARRAYGet all the resources which do not have any of these IDs

 

At most, one of the following:

NameTypeNotes/Example
parent_idINTEGERGet the resources whose parent has this ID
parent__inARRAYGet any resource whose parents have any of these IDs
parent__not_inARRAYGet all resources whose parents do not have any of these IDs

 

At most, one of the following:

NameTypeNotes/Example
category_idINTEGERGet the resources of the category that has this ID
category__inARRAYGet the resources of the categories that have any of these IDs
category__not_inARRAYGet the resources of all the categories that do not have any of these IDs


You can set the order of the results by setting the STRING value of the parameter orderby to one of the following :

  • none
  • id
  • name (default)
  • slug
  • type
  • parent_id
  • date
  • resource__in (preserve order given in the resource__in array)

 

You can set the direction of the ordering of the results by setting the STRING value of the parameter order to one of the following :

  • ASC  (default)
  • DESC

 

You can further limit the results based on attributes the resources may have:

NameTypeNotes/Example
attr_keySTRINGThe name of the attribute. Example: network-fqdn
attr_valueSTRINGThe value of any attribute, or if attr_key is specified, the value of the attribute defined in attr_key.
attr_compareSTRING

If both attr_key and attr_value are given, the results are by default compared based on the value given as attr_value being equal to the value stored in the database. You can optionally change this by setting the STRING value of attr_compare to one of the following:

  • =  (default)
  • !=
  • ﹥
  • ﹥=
  • ﹤
  • ﹤=
  • LIKE
  • NOT LIKE
  • IN
  • NOT IN
  • BETWEEN
  • NOT BETWEEN
  • NOT EXISTS

 

You can restrict the range of the resources returned.

NameTypeNotes/Example
resources_per_pageINTEGERHow many resources to return.
offsetINTEGERHow many resources to offset (the initial resource is 0, not 1).
pagedINTEGERThe page to return (starts at 1, not 0). This parameter is provided for convenience and is used to calculate the offset where: offset=(paged-1)*resources_per_page
Example URL/api/v1/api.php?target=resource&action=get&id=7

add

URL/api/v1/api.php?target=resource&action=add
DescriptionAdd a resource.
Returns

Examples:

/api/v1/api.php?target=resource&action=add&meta[name]=apitest&meta[type]=entry&meta[section]=firewall&fields[network-fqdn][]=www.example.com

SUCCESSFUL: {"success":1,"message":"Resource added","data":{"id":1077,"name":"apitest","slug":"apitest","type":"entry","parent_id":1,"category_id":"NULL","attr":{"_section":"70","network-fqdn":"www.example.com"},"section":{"id":"70","name":"Firewall","slug":"firewall","type":"section","parent_id":"1","category_id":null,"attr":{}}}}

/api/v1/api.php?target=resource&action=add&meta[name]=apitest&meta[type]=entry&fields[network-fqdn][]=www.example.com

ERROR:{"success":0,"message":"Entries must be assigned to a section"}

Required Parameters
NameTypeNotes/Example
meta[name]STRINGName of the resource
meta[type]STRINGType of resource (entry, section, field, ect)
Optional Parameters
NameTypeNotes/Example
meta[parent_id]INTEGERID of the parent resource
meta[category_id]INTEGERID of the category

Required Parameters

(meta[type] = entry)


One of the following:

NameTypeNotes/Example
meta[section_id]INTEGERID of the section that the entry will be assigned to
meta[section]STRINGSlug of the section that the entry will be assigned to

Optional Parameters

(meta[type] = entry)

NameTypeNotes/Example
fields[]ARRAY

Entry field values (for fields that have already been assigned to the section) can be populated when the entry is created.

The format is field[field-slug][field-instance]. If the field instance is left blank, it will simply be the next value in the instance array. For example:

fields[network-fqdn][]=example.com&fields[network-fqdn][]=test.com

would be written in JSON as

var fields = {
     "network-fqdn": [
          "example.com",
          "test.com"
     ]
}

A field can be added to a section multiple times. The field instance is used to keep track of which field occurrence we are referring. In this example, the network-fqdn field had been added twice to the section so we were able to store two values for it.

meta[custom_id]STRINGA custom ID for the entry. In the past this has been called the Resource Holder ID or Customer ID. Most recently it was implemented as a text field with the slug "6c-resourceholder-id." Now it is a fundamental part the entry type resources.

Required Parameters

(meta[type] = field)

NameTypeNotes/Example
meta[field_type]STRING

Type of field

  • text
  • textarea
  • radios
  • checkboxes
  • choicebox

Optional Parameters

(meta[type] = field)

NameTypeNotes/Example
meta[help_block]STRINGFields can have a line of text under them with instructions
meta[options]ARRAY

Fields of type radios, checkboxes, or choicebox can have multiple options. This could be multiple radio buttons or a choicebox (dropdown) with several options. For example:

meta[type]=field&meta[name]=Colors&meta[field_type]=choicebox&meta[options][]=Blue&meta[options][]=Green

Will create a choicebox with dropdown options of Blue and Green.

update

URL/api/v1/api.php?target=resource&action=update
DescriptionUpdate a resource.
Returns

Examples:
SUCCESSFUL: {"success":1,"message":"Resource Updated","data":{"id":"1055","name":"87-child-1","slug":"87-child-1","type":"entry","parent_id":"87","category_id":"65","attr":{"_section":"70"},"section":{"id":"70","name":"Firewall","slug":"firewall","type":"section","parent_id":"1","category_id":null,"attr":{}}}}

ERROR: {"success":0,"message":"No resource found with ID: 1079"}

Required Parameters
NameTypeNotes/Example
meta[id]INTEGERID of resource
meta[type]STRINGType of resource (entry, section, field, ect)

Optional Parameters

(meta[type] = entry)

NameTypeNotes/Example
fields[]ARRAYSee "add" documentation

Optional Parameters

(meta[type] = section)

NameTypeNotes/Example
fields[]ARRAY

The fields value should be all the fields that are assigned to the section. Giving an empty array as the fields value will remove all fields from the section.

The format is:

fields[position][key]

The position value is the position that the field will appear in (0 is first). The position value must always be included. An example field format for an existing field could be:

fields[0][id]=2
fields[0][slug]=asset-serial-number
fields[0][help_block]=something
fields[0][new]=false

  • Either the id or the slug is required, not both.
  • When the "new" parameter is not included, FALSE is assumed

If you want to create a new field and assign it to the section, use a format like this:

fields[10][name]=TextArea
fields[10][field_type]=textarea
fields[10][new]=true

 

delete

URL/api/v1/api.php?target=resource&action=delete
DescriptionDelete a resource.
ReturnsExamples:
SUCCESSFUL: {"success":1,"message":"Resource deleted."}
ERROR: {"success":0,"message":"No resource found with ID: 57"}
Required Parameters
NameTypeNotes/Example
idINTEGERID of the resource
Example URL/api/v1/api.php?target=resource&action=delete&id=57
  • No labels