Integratec API Platform
callResource-addressTables

Description

Manages resources rooted at the address table catalog.

Example for Add Records

Request

This request adds records to an address table.

Note
If you want to add a large number of records, we recommended that you split the data across multiple requests, ie. batches. Increasing the batch size improves performance by limiting the effect of the request overhead, but also increases the memory usage.
{
"method": "resourceAdd",
"params": [
[
"addressTables",
"2736298458",
"records"
],
[
{
"COMPANY": "BCC Software, LLC",
"DELADDR": "75 Josons Drive",
"CITY": "Rochester",
"STATE": "NY",
"ZIPCODE": "14623"
},
{
"COMPANY": "XYZ Company",
"DELADDR": "1 Main Street",
"CITY": "Anytown",
"STATE": "NY",
"ZIPCODE": "12345"
}
]
]
}

Reply

result is an array of bookmarks of the new records.

{
"result": [
"AgAAAA==",
"AwAAAA=="
]
}

Example for Get Records

Request

This request gets records from an address table.

Note
If you want to get a large number of records, we recommended that you split the data across multiple requests, ie. batches. Increasing the batch size improves performance by limiting the effect of the request overhead, but also increases the memory usage.
{
"method": "resourceGet",
"params": [
[
"addressTables",
"2736298458",
"records"
],
true,
"",
1000
]
}

Reply

The result has an items property, which is an array of records, and an itemBookmarks property, which is an array of bookmarks for the items.

{
"items": [
{
"COMPANY": "BCC Software, LLC",
"DELADDR": "75 Josons Drive",
"CITY": "Rochester",
"STATE": "NY",
"ZIPCODE": "14623"
},
{
"COMPANY": "XYZ Company",
"DELADDR": "1 Main Street",
"CITY": "Anytown",
"STATE": "NY",
"ZIPCODE": "12345"
}
],
"itemBookmarks" : [
"AQAAAA==",
"AgAAAA=="
]
}

Example for Add Selectivity

Request

This request adds a selectivity to an address table.

{
"method": "resourceAdd",
"params": [
[
"addressTables",
"2736298458",
"selectivities"
],
[
"name",
"expression"
],
[
"Bad Records",
"(Empty(DP))"
]
]
}

Reply

result is the id of the new selectivity.

{
"result": "0267163171"
}

Example for Add Index

Request

This request adds an index to an address table.

{
"method": "resourceAdd",
"params": [
[
"addressTables",
"2736298458",
"indexes"
],
[
"name",
"expression",
"descending",
"unique"
],
[
"Sample",
"(Address)",
true,
false
]
]
}

Reply

result is the id of the new index.

{
"result": "SAMPLE"
}

Example for Get Indexes

Request

This request gets an array of indexes for an address table.

{
"method": "resourceGet",
"params": [
[
"addresstables",
"2736298458",
"indexes"
]
]
}

Reply

items is an array of objects, each representing an index.

{
"result": {
"items": [
{
"id": "ZIP",
"name": "ZIP",
"expression": "UPPER(ZIP4)",
"unique": false,
"descending": false
},
{
"id": "STATE",
"name": "STATE",
"expression": "UPPER(STATE)",
"unique": false,
"descending": false
}
]
}
}

Request Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"description":"Makes a resource Remote Procedure Call (RPC) for resources.",
"definitions":{
"objectOrString":{
"oneOf":[
{
"type":"object"
},
{
"type":"string"
}
]
},
"resourceNames":{
"type":"array",
"items":{
"type":"string",
"minLength":1
}
},
"resourceId":{
"type":"array",
"minItems":1,
"maxItems":4,
"items":{
"type":"string",
"minLength":1
}
},
"resourceValues":{
"type":"array",
"items":{
"$ref":"#/definitions/scalarOrNull"
}
},
"scalarOrNull":{
"oneOf":[
{
"type":[
"boolean",
"integer",
"null",
"number",
"string"
]
},
{
"type":"object",
"required":[
"dateTime"
],
"properties":{
"dateTime":{
"type":"string",
"pattern":"^([0-9]{4})-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])([T]([01][0-9]|2[0-3]):([0-5][0-9])(:([0-5][0-9])(\\.[0-9]{1,3})?)?)?$"
}
}
}
]
}
},
"type":"object",
"oneOf":[
{
"description":"RPC parameters for resourceAdd()",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourceAdd"
]
},
"params":{
"title":"Parameters",
"oneOf":[
{
"description":"Parameters to pass to resourceAdd(array resourceId, object resource).",
"type":"array",
"minItems":2,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/objectOrString"
}
],
"additionalItems":false
},
{
"description":"Parameters to pass to resourceAdd(array resourceId, array names, array values).",
"type":"array",
"minItems":3,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/resourceNames"
},
{
"$ref":"#/definitions/resourceValues"
}
],
"additionalItems":false
},
{
"description":"Parameters to pass to resourceAdd(array resourceId, array resources).",
"type":"array",
"minItems":2,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"type":"array",
"items":{
"type":"object"
}
}
],
"additionalItems":false
}
]
}
},
"additionalProperties":false
},
{
"description":"RPC parameters for resourceDelete().",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourceDelete"
]
},
"params":{
"title":"Parameters",
"description":"Parameters to pass to resourceDelete(array resourceId).",
"type":"array",
"minItems":1,
"items":[
{
"$ref":"#/definitions/resourceId"
}
],
"additionalItems":false
}
},
"additionalProperties":false
},
{
"description":"RPC parameters for resourceFind().",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourceFind"
]
},
"params":{
"title":"Parameters",
"description":"Parameters to pass to resourceFind(array resourceId, array findNames, array findValues, array names).",
"type":"array",
"minItems":3,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/resourceNames"
},
{
"$ref":"#/definitions/resourceValues"
},
{
"$ref":"#/definitions/resourceNames"
}
],
"additionalItems":false
}
},
"additionalProperties":false
},
{
"description":"RPC parameters for resourceGet().",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourceGet"
]
},
"params":{
"title":"Parameters",
"oneOf":[
{
"description":"Parameters to pass to resourceGet(array resourceId, array names).",
"type":"array",
"minItems":1,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/resourceNames"
}
],
"additionalItems":false
},
{
"description":"Parameters to pass to resourceGet(array resourceId, boolean forwards, string bookmark, integer count, array names).",
"type":"array",
"minItems":3,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"type":"boolean"
},
{
"type":"string"
},
{
"type":"integer",
"minimum":-1
},
{
"$ref":"#/definitions/resourceNames"
}
],
"additionalItems":false
}
]
}
},
"additionalProperties":false
},
{
"description":"RPC parameters for resourcePut()",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourcePut"
]
},
"params":{
"title":"Parameters",
"oneOf":[
{
"description":"Parameters to pass to resourcePut(array resourceId, object resource).",
"type":"array",
"minItems":2,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/objectOrString"
}
],
"additionalItems":false
},
{
"description":"Parameters to pass to resourcePut(array resourceId, array names, array values).",
"type":"array",
"minItems":3,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/resourceNames"
},
{
"$ref":"#/definitions/resourceValues"
}
],
"additionalItems":false
}
]
}
},
"additionalProperties":false
},
{
"description":"RPC parameters for resourceSet()",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourceSet"
]
},
"params":{
"title":"Parameters",
"oneOf":[
{
"description":"Parameters to pass to resourceSet(array resourceId, array names, array values).",
"type":"array",
"minItems":2,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/objectOrString"
}
],
"additionalItems":false
},
{
"description":"Parameters to pass to resourceSet(array resourceId, array names, array values).",
"type":"array",
"minItems":3,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/resourceNames"
},
{
"$ref":"#/definitions/resourceValues"
}
],
"additionalItems":false
}
]
}
},
"additionalProperties":false
}
]
}

Reply Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"definitions":{
"dateTime":{
"type":"object",
"required":[
"dateTime"
],
"properties":{
"dateTime":{
"type":"string",
"minLength":1
}
}
},
"scalarOrNull":{
"oneOf":[
{
"type":[
"boolean",
"integer",
"null",
"number",
"string"
]
},
{
"$ref":"#/definitions/dateTime"
}
]
}
},
"type":"object",
"required":[
"result"
],
"properties":{
"result":{
"title":"Result",
"description":"Result of the RPC.",
"oneOf":[
{
"type":"object"
},
{
"$ref":"#/definitions/scalarOrNull"
},
{
"type":"array",
"items": {
"$ref":"#/definitions/scalarOrNull"
}
}
]
}
},
"additionalProperties":false
}