Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

Comment: Published by Scroll Versions from this space and version 7.1.1

...

General Parameters:

get
URL	/api/v1/api.php?target=resource&action=get
Description	Get a resource or resources
Returns	Examples: 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		Name

Name	Type	Notes/Example
name	STRING	Name of the resource. Example: 6Connect, Inc.
slug	STRING	The unique URL friendly name of the resource. Example: 6connect-inc
type	STRING	Type of resource (eg. entry, field, category, dnsmodule)

At most, one of the following:

Name	Type	Notes/Example
id	INTEGER	Get the resource which has this ID
resource__in	ARRAY	Get any resource which has any of these IDs Syntax: &resource__in[]=1771&resource__in[]=14238 (Each resource id you wish to search over gets its own phrase.)
resource__not_in	ARRAY	Get all the resources which do not have any of these IDs Syntax: &resource__not_in[]=1771&resource__not_in[]=14238 (Each resource id you wish to exclude gets its own phrase.)

Name

Type

Notes/Example

INTEGER

Get the resource which has this ID

resource__in

ARRAY

Get any resource which has any of these IDs

Syntax: &resource__in[]=1771&resource__in[]=14238 (Each resource id you wish to search over gets its own phrase.)

resource__not_in

ARRAY

Get all the resources which do not have any of these IDs

Syntax: &resource__not_in[]=1771&resource__not_in[]=14238 (Each resource id you wish to exclude gets its own phrase.)

At most, one of the following:

search	STRING	Search the resource system for the provided term. Performs a "LIKE" search to return similar results. Similar to GET Resource SEARCH call.
search_column	STRING	Column to perform a 'search' on.
permissions__true	STRING	Set the permissions that must be true. Typically only used for UI / Gadget permissions.
permissions__false	STRING	Set the permissions that must be false. Typically only used for UI / Gadget permissions.
getFromBackup	INTEGER	Use data from the resource_archive table instead of the standard resource table, used with "orig_id" identifying parameter.

Limit Results by ID:

At most, one of the following:

Name

Type	Notes/Example

parent_

INTEGER

Get the

resources whose parent

resource which has this ID

parent

orig_

_in

id	INTEGER	The resource id from the standard resource table, used in conjunction with 'getFromBackup'.
custom_id	INTEGER	The resource custom id provided by the user for the resource.
resource__in	ARRAY	Get any resource

whose parents have

which has any of these IDs

Syntax: &

parent

resource__in[]=

162

1771&

parent

resource__in[]=

299

14238 (Each

parent

resource id you wish to search over gets its own phrase.)

parent

resource__not_in

ARRAY

Get all the resources

whose parents

which do not have any of these IDs

Syntax: &

parent

resource__not_in[]=1771&

parent

resource__not_in[]=14238 (Each

parent

resource id you wish to exclude gets its own phrase.)

At most, one of the following:

Name	Type	Notes/Example

category

parent_id

INTEGER

Get the resources

of the category that

whose parent has this ID

category

parent__in

ARRAY

Get any

resources

resource whose

category

parent__in[]=

11002

162&

category

parent__in[]=

11003

299 (Each

category

parent id you wish to search over gets its own phrase.)

category

parent__not_in

ARRAY

Get

the resources of all the categories that

all resources whose parents do not have any of these IDs

Syntax: &parent__not_in[]=

11002

1771&parent__not_in[]=

11003

14238 (Each

category

parent id you wish to exclude gets its own phrase.)

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

At most, one of the following:

none

Name

name (default)

slug

type

Type	Notes/Example
category

parent

_id

date

resource__in (preserve order given in the resource

INTEGER	Get the resources of the category that has this ID
category__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:

Name	Type	Notes/Example
attr_key	STRING	The name of the attribute. Example: network-fqdn
attr_value	STRING	The value of any attribute, or if attr_key is specified, the value of the attribute defined in attr_key.
attr_compare	STRING	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

Name

Type

Notes/Example

attr_key

STRING

The name of the attribute. Example: network-fqdn

attr_value

STRING

The value of any attribute, or if attr_key is specified, the value of the attribute defined in attr_key.

attr_compare

STRING

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

Note
When attr_compare is set to IN, NOT IN, BETWEEN, NOT BETWEEN, then attr_value must either be an array or a comma separated string.

You can search on multiple attributes by including an array of attribute options:

Name	Type	Notes/Example
attributes	ARRAY	var data = { "type: "entry", "attributes": [ { "attr_key": "_section", "attr_value": "105", }, { "attr_key": "address-mail-state", "attr_value": "CA", } ], "resources_per_page: 10 }

Name

Type

Notes/Example

attributes

ARRAY

var data = {

     "type: "entry",

     "attributes": [

               "attr_key": "_section",

               "attr_value": "105",

},

               "attr_key": "address-mail-state",

               "attr_value": "CA",

],

     "resources_per_page: 10

ARRAY

Get any resources whose categories have any of these IDs.

Syntax: &category__in[]=11002&category__in[]=11003 (Each category id you wish to search over gets its own phrase.)

category__not_in

ARRAY

Get the resources of all the categories that do not have any of these IDs

Syntax: &parent__not_in[]=11002&parent__not_in[]=11003 (Each category id you wish to exclude gets its own phrase.)

Limit Results by Resource Link:

For resources for which exist a Resource Link, you may limit by resource link data:

Name

Type

Notes/Example

resource_link_type

STRING

The resource linkage relation name. Valid values include:

For type = dnsmodule:

Valid Value	Notes
dnsViewACL	Links a ACL and a Group. The View (Group) must be resource1, resource id and the ACL resource must be resource2 in the linkage table
dnsViewServer	Links a View (Group) with Server (DNS Connector), and the Group resource must be as resource1 and DNS Module as resource2. Used for attaching DNS servers to DNS Groups.
dnsZoneMaster	Links a DNS Zone resource with the Server that will be exported as Master. The DNS Zone must be in resource1 and the server as resource2. Used for Directly attaching zones to servers.
dnsZoneSlave	Links a DNS Zone resource with the Server that will be exported as Slave. The DNS Zone must be in resource1 and the server as resource2. Used for Directly attaching zones to servers.
dnsZoneServer	Links a DNS Zone resource with a Server resource. The DNS Zone must be in resource1 and the server as resource2. Used to directly attach servers to zones.
dnsZoneView	Links a DNS Zone resource with a Group. The DNS Zone must be resource1, the Group resource as resource 2.

resource_link_column

INTEGER

The column to be used for the parameter in "resource_link_value". Valid integer values are:

'1' = to use resource1 in the first column

'2' = to use resource2 in the second column

resource_link_value

INTEGER

The resource id for the resource_linkage table to search (Example: "10697")

Limit Results by Attributes:

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

Name

Type

Notes/Example

attributes

ARRAY

You can search on multiple attributes by including an array of attribute options:

var data = {

     "type: "entry",

     "attributes": [

               "attr_key": "_section",

               "attr_value": "105",

},

               "attr_key": "address-mail-state",

               "attr_value": "CA",

],

     "resources_per_page: 10

attr_key

STRING

The name of the attribute. Example: network-fqdn

attr_value

STRING

The value of any attribute, or if attr_key is specified, the value of the attribute defined in attr_key.

attr_compare

STRING

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

Note
When attr_compare is set to IN, NOT IN, BETWEEN, NOT BETWEEN, then attr_value must either be an array or a comma separated string.

attr_load

BOOL

Load resource attributes along with the resource entry

Result Ordering:

Name

Type

Notes/Example

order

STRING

Set the direction of the ordering of the results by ascending or descending order. Valid values are:

ASC (default)
DESC

orderby

STRING

The parameter to order results by. Valid values include:

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

Range Selection / Paging:

You can restrict the range of the resources returned.

Name	Type	Notes/Example
resources_per_page	INTEGER	How many resources to return per page, e.g.: '10' .
offset	INTEGER	How many resources to offset from the initial resource, to use as the first resource provided in the return list (the initial resource is 0, not 1).
paged	INTEGER	The 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

...

Page tree

Versions Compared

Old Version 36

New Version 37

Key

get