Created
April 12, 2013 20:26
-
-
Save bendiy/5374872 to your computer and use it in GitHub Desktop.
XM.Contact REST API Discovery Document
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "kind":"discovery#restDescription", | |
| "etag":"", | |
| "discoveryVersion":"v1alpha1", | |
| "id":"dev:v1alpha1", | |
| "name":"dev", | |
| "version":"v1alpha1", | |
| "revision":"20130412", | |
| "title":"xTuple ERP REST API", | |
| "description":"Lets you get and manipulate xTuple ERP business objects.", | |
| "icons":{ | |
| "x16":"{iconx16}", | |
| "x32":"{iconx32}" | |
| }, | |
| "documentationLink":"https://dev.xtuple.com", | |
| "protocol":"rest", | |
| "baseUrl":"{rootUrl}api/v1alpha1/", | |
| "basePath":"/api/v1alpha1/", | |
| "rootUrl":"{rootUrl}", | |
| "servicePath":"api/v1alpha1/", | |
| "batchPath":"batch", | |
| "parameters":{ | |
| "alt":{ | |
| "type":"string", | |
| "description":"Data format for the response.", | |
| "default":"json", | |
| "enum":[ | |
| "json" | |
| ], | |
| "enumDescriptions":[ | |
| "Responses with Content-Type of application/json" | |
| ], | |
| "location":"query" | |
| }, | |
| "fields":{ | |
| "type":"string", | |
| "description":"Selector specifying which fields to include in a partial response.", | |
| "location":"query" | |
| }, | |
| "oauth_token":{ | |
| "type":"string", | |
| "description":"OAuth 2.0 token for the current user.", | |
| "location":"query" | |
| }, | |
| "prettyPrint":{ | |
| "type":"boolean", | |
| "description":"Returns response with indentations and line breaks.", | |
| "default":"true", | |
| "location":"query" | |
| } | |
| }, | |
| "auth":{ | |
| "oauth2":{ | |
| "scopes":{ | |
| "{rootUrl}auth/dev":{ | |
| "description":"Full access to all 'dev' resources" | |
| }, | |
| "{rootUrl}auth/dev/contact":{ | |
| "description":"Manage Contact resources" | |
| }, | |
| "{rootUrl}auth/dev/contact.readonly":{ | |
| "description":"View Contact resources" | |
| } | |
| } | |
| } | |
| }, | |
| "schemas":{ | |
| "AccountRelation":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "description":"Internal ID of this CRM Account.", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "number":{ | |
| "title":"Number", | |
| "description":"Abbreviated human-readable identifier for this CRM Account.", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "name":{ | |
| "title":"Name", | |
| "description":"Long name of this CRM Account.", | |
| "type":"string" | |
| }, | |
| "isActive":{ | |
| "title":"Is Active", | |
| "description":"This CRM Account is available for new activity.", | |
| "type":"boolean" | |
| }, | |
| "owner":{ | |
| "title":"Owner", | |
| "type":"object", | |
| "$ref":"UserAccountRelation" | |
| } | |
| } | |
| }, | |
| "AddressInfo":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "number":{ | |
| "title":"Number", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "isActive":{ | |
| "title":"Is Active", | |
| "type":"boolean" | |
| }, | |
| "line1":{ | |
| "title":"Line1", | |
| "type":"string" | |
| }, | |
| "line2":{ | |
| "title":"Line2", | |
| "type":"string" | |
| }, | |
| "line3":{ | |
| "title":"Line3", | |
| "type":"string" | |
| }, | |
| "city":{ | |
| "title":"City", | |
| "type":"string" | |
| }, | |
| "state":{ | |
| "title":"State", | |
| "type":"string" | |
| }, | |
| "postalCode":{ | |
| "title":"Postal Code", | |
| "type":"string" | |
| }, | |
| "country":{ | |
| "title":"Country", | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "Characteristic":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "name":{ | |
| "title":"Name", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "characteristicType":{ | |
| "title":"Characteristic Type", | |
| "required":true, | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "isSearchable":{ | |
| "title":"Is Searchable", | |
| "required":true, | |
| "type":"boolean" | |
| }, | |
| "order":{ | |
| "title":"Order", | |
| "required":true, | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "notes":{ | |
| "title":"Notes", | |
| "type":"string" | |
| }, | |
| "mask":{ | |
| "title":"Mask", | |
| "type":"string" | |
| }, | |
| "validator":{ | |
| "title":"Validator", | |
| "type":"string" | |
| }, | |
| "options":{ | |
| "title":"Options", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"CharacteristicOption" | |
| } | |
| }, | |
| "isAddresses":{ | |
| "title":"Is Addresses", | |
| "type":"boolean", | |
| "required":true | |
| }, | |
| "isContacts":{ | |
| "title":"Is Contacts", | |
| "type":"boolean", | |
| "required":true | |
| }, | |
| "isAccounts":{ | |
| "title":"Is Accounts", | |
| "type":"boolean" | |
| }, | |
| "isItems":{ | |
| "title":"Is Items", | |
| "type":"boolean", | |
| "required":true | |
| } | |
| } | |
| }, | |
| "CharacteristicOption":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "description":"Primary key", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "characteristic":{ | |
| "title":"Characteristic", | |
| "description":"Reference to char table", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "value":{ | |
| "title":"Value", | |
| "description":"Option value", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "order":{ | |
| "title":"Order", | |
| "description":"Option sort order", | |
| "required":true, | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| } | |
| } | |
| }, | |
| "ClassCode":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "code":{ | |
| "title":"Code", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "description":{ | |
| "title":"Description", | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "CommentType":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "name":{ | |
| "title":"Name", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "description":{ | |
| "title":"Description", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "isSystem":{ | |
| "title":"Is System", | |
| "required":true, | |
| "type":"boolean" | |
| }, | |
| "commentsEditable":{ | |
| "title":"Comments Editable", | |
| "required":true, | |
| "type":"boolean" | |
| }, | |
| "order":{ | |
| "title":"Order", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647", | |
| "required":true | |
| }, | |
| "sources":{ | |
| "title":"Sources", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"CommentTypeSource" | |
| } | |
| } | |
| } | |
| }, | |
| "CommentTypeSource":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "commentType":{ | |
| "title":"Comment Type", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "source":{ | |
| "title":"Source", | |
| "type":"object", | |
| "$ref":"Source" | |
| } | |
| } | |
| }, | |
| "Contact":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "number":{ | |
| "title":"Number", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "isActive":{ | |
| "title":"Is Active", | |
| "type":"boolean" | |
| }, | |
| "honorific":{ | |
| "title":"Honorific", | |
| "type":"string" | |
| }, | |
| "firstName":{ | |
| "title":"First Name", | |
| "type":"string" | |
| }, | |
| "middleName":{ | |
| "title":"Middle Name", | |
| "type":"string" | |
| }, | |
| "lastName":{ | |
| "title":"Last Name", | |
| "type":"string" | |
| }, | |
| "suffix":{ | |
| "title":"Suffix", | |
| "type":"string" | |
| }, | |
| "jobTitle":{ | |
| "title":"Job Title", | |
| "type":"string" | |
| }, | |
| "initials":{ | |
| "title":"Initials", | |
| "type":"string" | |
| }, | |
| "phone":{ | |
| "title":"Phone", | |
| "type":"string" | |
| }, | |
| "alternate":{ | |
| "title":"Alternate", | |
| "type":"string" | |
| }, | |
| "fax":{ | |
| "title":"Fax", | |
| "type":"string" | |
| }, | |
| "primaryEmail":{ | |
| "title":"Primary Email", | |
| "type":"string" | |
| }, | |
| "webAddress":{ | |
| "title":"Web Address", | |
| "type":"string" | |
| }, | |
| "account":{ | |
| "title":"Account", | |
| "type":"object", | |
| "$ref":"AccountRelation" | |
| }, | |
| "owner":{ | |
| "title":"Owner", | |
| "type":"object", | |
| "$ref":"UserAccountRelation" | |
| }, | |
| "notes":{ | |
| "title":"Notes", | |
| "type":"string" | |
| }, | |
| "address":{ | |
| "title":"Address", | |
| "type":"object", | |
| "$ref":"AddressInfo" | |
| }, | |
| "email":{ | |
| "title":"Email", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"ContactEmail" | |
| } | |
| }, | |
| "comments":{ | |
| "title":"Comments", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"ContactComment" | |
| } | |
| }, | |
| "characteristics":{ | |
| "title":"Characteristics", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"ContactCharacteristic" | |
| } | |
| }, | |
| "accounts":{ | |
| "title":"Accounts", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"ContactAccount" | |
| } | |
| }, | |
| "contacts":{ | |
| "title":"Contacts", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"ContactContact" | |
| } | |
| }, | |
| "items":{ | |
| "title":"Items", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"ContactItem" | |
| } | |
| }, | |
| "files":{ | |
| "title":"Files", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"ContactFile" | |
| } | |
| }, | |
| "urls":{ | |
| "title":"Urls", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"ContactUrl" | |
| } | |
| } | |
| } | |
| }, | |
| "ContactAccount":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "sourceType":{ | |
| "title":"Source Type", | |
| "type":"string" | |
| }, | |
| "source":{ | |
| "title":"Source", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "targetType":{ | |
| "title":"Target Type", | |
| "type":"string" | |
| }, | |
| "account":{ | |
| "title":"Account", | |
| "type":"object", | |
| "$ref":"AccountRelation" | |
| }, | |
| "purpose":{ | |
| "title":"Purpose", | |
| "type":"string", | |
| "minLength":null, | |
| "maxLength":null | |
| } | |
| } | |
| }, | |
| "ContactCharacteristic":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "targetType":{ | |
| "title":"Target Type", | |
| "type":"string" | |
| }, | |
| "contact":{ | |
| "title":"Contact", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "characteristic":{ | |
| "title":"Characteristic", | |
| "type":"object", | |
| "$ref":"Characteristic", | |
| "required":true | |
| }, | |
| "value":{ | |
| "title":"Value", | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "ContactComment":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "sourceType":{ | |
| "title":"Source Type", | |
| "type":"string" | |
| }, | |
| "contact":{ | |
| "title":"Contact", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "commentType":{ | |
| "title":"Comment Type", | |
| "type":"object", | |
| "$ref":"CommentType", | |
| "required":true | |
| }, | |
| "text":{ | |
| "title":"Text", | |
| "type":"string" | |
| }, | |
| "isPublic":{ | |
| "title":"Is Public", | |
| "type":"boolean" | |
| }, | |
| "created":{ | |
| "title":"Created", | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "createdBy":{ | |
| "title":"Created By", | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "ContactContact":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "sourceType":{ | |
| "title":"Source Type", | |
| "type":"string" | |
| }, | |
| "source":{ | |
| "title":"Source", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "targetType":{ | |
| "title":"Target Type", | |
| "type":"string" | |
| }, | |
| "contact":{ | |
| "title":"Contact", | |
| "type":"object", | |
| "$ref":"ContactRelation" | |
| }, | |
| "purpose":{ | |
| "title":"Purpose", | |
| "type":"string", | |
| "minLength":null, | |
| "maxLength":null | |
| } | |
| } | |
| }, | |
| "ContactEmail":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "description":"Primary key", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "contact":{ | |
| "title":"Contact", | |
| "description":"Reference to contact table", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "email":{ | |
| "title":"Email", | |
| "description":"Alternate information", | |
| "required":true, | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "ContactFile":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "sourceType":{ | |
| "title":"Source Type", | |
| "type":"string" | |
| }, | |
| "source":{ | |
| "title":"Source", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "targetType":{ | |
| "title":"Target Type", | |
| "type":"string" | |
| }, | |
| "file":{ | |
| "title":"File", | |
| "type":"object", | |
| "$ref":"FileRelation" | |
| }, | |
| "purpose":{ | |
| "title":"Purpose", | |
| "type":"string", | |
| "minLength":null, | |
| "maxLength":null | |
| } | |
| } | |
| }, | |
| "ContactItem":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "sourceType":{ | |
| "title":"Source Type", | |
| "type":"string" | |
| }, | |
| "source":{ | |
| "title":"Source", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "targetType":{ | |
| "title":"Target Type", | |
| "type":"string" | |
| }, | |
| "item":{ | |
| "title":"Item", | |
| "type":"object", | |
| "$ref":"ItemRelation" | |
| }, | |
| "purpose":{ | |
| "title":"Purpose", | |
| "type":"string", | |
| "minLength":null, | |
| "maxLength":null | |
| } | |
| } | |
| }, | |
| "ContactListItem":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "isActive":{ | |
| "title":"Is Active", | |
| "type":"boolean" | |
| }, | |
| "name":{ | |
| "title":"Name", | |
| "type":"string" | |
| }, | |
| "firstName":{ | |
| "title":"First Name", | |
| "type":"string" | |
| }, | |
| "lastName":{ | |
| "title":"Last Name", | |
| "type":"string" | |
| }, | |
| "jobTitle":{ | |
| "title":"Job Title", | |
| "type":"string" | |
| }, | |
| "phone":{ | |
| "title":"Phone", | |
| "type":"string" | |
| }, | |
| "alternate":{ | |
| "title":"Alternate", | |
| "type":"string" | |
| }, | |
| "fax":{ | |
| "title":"Fax", | |
| "type":"string" | |
| }, | |
| "primaryEmail":{ | |
| "title":"Primary Email", | |
| "type":"string" | |
| }, | |
| "webAddress":{ | |
| "title":"Web Address", | |
| "type":"string" | |
| }, | |
| "address":{ | |
| "title":"Address", | |
| "type":"object", | |
| "$ref":"AddressInfo" | |
| }, | |
| "owner":{ | |
| "title":"Owner", | |
| "type":"object", | |
| "$ref":"UserAccountRelation" | |
| }, | |
| "account":{ | |
| "title":"Account", | |
| "type":"object", | |
| "$ref":"AccountRelation" | |
| }, | |
| "characteristics":{ | |
| "title":"Characteristics", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"ContactListItemCharacteristic" | |
| } | |
| } | |
| } | |
| }, | |
| "ContactListItemCharacteristic":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "targetType":{ | |
| "title":"Target Type", | |
| "type":"string" | |
| }, | |
| "contact":{ | |
| "title":"Contact", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "characteristic":{ | |
| "title":"Characteristic", | |
| "type":"object", | |
| "$ref":"Characteristic", | |
| "required":true | |
| }, | |
| "value":{ | |
| "title":"Value", | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "ContactRelation":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "isActive":{ | |
| "title":"Is Active", | |
| "type":"boolean" | |
| }, | |
| "name":{ | |
| "title":"Name", | |
| "type":"string" | |
| }, | |
| "firstName":{ | |
| "title":"First Name", | |
| "type":"string" | |
| }, | |
| "lastName":{ | |
| "title":"Last Name", | |
| "type":"string" | |
| }, | |
| "jobTitle":{ | |
| "title":"Job Title", | |
| "type":"string" | |
| }, | |
| "phone":{ | |
| "title":"Phone", | |
| "type":"string" | |
| }, | |
| "alternate":{ | |
| "title":"Alternate", | |
| "type":"string" | |
| }, | |
| "fax":{ | |
| "title":"Fax", | |
| "type":"string" | |
| }, | |
| "primaryEmail":{ | |
| "title":"Primary Email", | |
| "type":"string" | |
| }, | |
| "webAddress":{ | |
| "title":"Web Address", | |
| "type":"string" | |
| }, | |
| "address":{ | |
| "title":"Address", | |
| "type":"object", | |
| "$ref":"AddressInfo" | |
| }, | |
| "owner":{ | |
| "title":"Owner", | |
| "type":"object", | |
| "$ref":"UserAccountRelation" | |
| }, | |
| "account":{ | |
| "title":"Account", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| } | |
| } | |
| }, | |
| "ContactUrl":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "sourceType":{ | |
| "title":"Source Type", | |
| "type":"string" | |
| }, | |
| "source":{ | |
| "title":"Source", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "targetType":{ | |
| "title":"Target Type", | |
| "type":"string" | |
| }, | |
| "url":{ | |
| "title":"Url", | |
| "type":"object", | |
| "$ref":"Url" | |
| }, | |
| "purpose":{ | |
| "title":"Purpose", | |
| "type":"string", | |
| "minLength":null, | |
| "maxLength":null | |
| } | |
| } | |
| }, | |
| "FileRelation":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "name":{ | |
| "title":"Name", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "description":{ | |
| "title":"Description", | |
| "required":true, | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "FreightClass":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "code":{ | |
| "title":"Code", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "description":{ | |
| "title":"Description", | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "ItemRelation":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "number":{ | |
| "title":"Number", | |
| "type":"string" | |
| }, | |
| "isActive":{ | |
| "title":"Is Active", | |
| "type":"boolean" | |
| }, | |
| "description1":{ | |
| "title":"Description1", | |
| "type":"string" | |
| }, | |
| "description2":{ | |
| "title":"Description2", | |
| "type":"string" | |
| }, | |
| "inventoryUnit":{ | |
| "title":"Inventory Unit", | |
| "type":"object", | |
| "$ref":"Unit" | |
| }, | |
| "isFractional":{ | |
| "title":"Is Fractional", | |
| "type":"boolean" | |
| }, | |
| "classCode":{ | |
| "title":"Class Code", | |
| "type":"object", | |
| "$ref":"ClassCode" | |
| }, | |
| "isSold":{ | |
| "title":"Is Sold", | |
| "type":"boolean" | |
| }, | |
| "isConfigured":{ | |
| "title":"Is Configured", | |
| "type":"boolean" | |
| }, | |
| "freightClass":{ | |
| "title":"Freight Class", | |
| "type":"object", | |
| "$ref":"FreightClass" | |
| }, | |
| "barcode":{ | |
| "title":"Barcode", | |
| "type":"string" | |
| }, | |
| "listPrice":{ | |
| "title":"List Price", | |
| "type":"number", | |
| "format":"float" | |
| }, | |
| "standardCost":{ | |
| "title":"Standard Cost", | |
| "type":"number", | |
| "format":"float" | |
| }, | |
| "listCost":{ | |
| "title":"List Cost", | |
| "type":"number", | |
| "format":"float" | |
| }, | |
| "priceUnit":{ | |
| "title":"Price Unit", | |
| "type":"object", | |
| "$ref":"Unit" | |
| }, | |
| "priceUnitRatio":{ | |
| "title":"Price Unit Ratio", | |
| "type":"number", | |
| "format":"float" | |
| }, | |
| "productWeight":{ | |
| "title":"Product Weight", | |
| "type":"number", | |
| "format":"float" | |
| }, | |
| "packageWeight":{ | |
| "title":"Package Weight", | |
| "type":"number", | |
| "format":"float" | |
| }, | |
| "characteristics":{ | |
| "title":"Characteristics", | |
| "type":"array", | |
| "items":{ | |
| "$ref":"ItemRelationCharacteristic" | |
| } | |
| } | |
| } | |
| }, | |
| "ItemRelationCharacteristic":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "targetType":{ | |
| "title":"Target Type", | |
| "type":"string" | |
| }, | |
| "item":{ | |
| "title":"Item", | |
| "type":"integer", | |
| "format":"int32", | |
| "minimum":"-2147483648", | |
| "maximum":"2147483647" | |
| }, | |
| "characteristic":{ | |
| "title":"Characteristic", | |
| "type":"object", | |
| "$ref":"Characteristic", | |
| "required":true | |
| }, | |
| "value":{ | |
| "title":"Value", | |
| "type":"string" | |
| }, | |
| "isDefault":{ | |
| "title":"Is Default", | |
| "required":true, | |
| "type":"boolean" | |
| }, | |
| "price":{ | |
| "title":"Price", | |
| "required":true, | |
| "type":"number", | |
| "format":"float" | |
| } | |
| } | |
| }, | |
| "Source":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "description":"Primary key", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "module":{ | |
| "title":"Module", | |
| "description":"Application module", | |
| "type":"string" | |
| }, | |
| "name":{ | |
| "title":"Name", | |
| "description":"Name", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "description":{ | |
| "title":"Description", | |
| "description":"Description", | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "Unit":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "name":{ | |
| "title":"Name", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "description":{ | |
| "title":"Description", | |
| "type":"string" | |
| }, | |
| "isItemWeight":{ | |
| "title":"Is Item Weight", | |
| "required":true, | |
| "type":"boolean" | |
| } | |
| } | |
| }, | |
| "Url":{ | |
| "properties":{ | |
| "id":{ | |
| "title":"Id", | |
| "required":true, | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647", | |
| "isPrimaryKey":true | |
| }, | |
| "name":{ | |
| "title":"Name", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| "path":{ | |
| "title":"Path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "UserAccountRelation":{ | |
| "properties":{ | |
| "username":{ | |
| "title":"Username", | |
| "required":true, | |
| "type":"string", | |
| "isPrimaryKey":true | |
| }, | |
| "propername":{ | |
| "title":"Propername", | |
| "type":"string" | |
| }, | |
| "email":{ | |
| "title":"Email", | |
| "type":"string" | |
| }, | |
| "disableExport":{ | |
| "title":"Disable Export", | |
| "type":"boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "resources":{ | |
| "Contact":{ | |
| "methods":{ | |
| "delete":{ | |
| "id":"contact-id.delete", | |
| "path":"contact/{contact-id}", | |
| "httpMethod":"DELETE", | |
| "description":"Deletes a single Contact record.", | |
| "parameters":{ | |
| "contact-id":{ | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647" | |
| } | |
| }, | |
| "parameterOrder":[ | |
| "contact-id" | |
| ], | |
| "scopes":[ | |
| "{rootUrl}auth/dev", | |
| "{rootUrl}auth/dev/contact" | |
| ] | |
| }, | |
| "get":{ | |
| "id":"contact-id.get", | |
| "path":"contact/{contact-id}", | |
| "httpMethod":"GET", | |
| "description":"Gets a single Contact record.", | |
| "parameters":{ | |
| "contact-id":{ | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647" | |
| } | |
| }, | |
| "parameterOrder":[ | |
| "contact-id" | |
| ], | |
| "response":{ | |
| "ref$":"Contact" | |
| }, | |
| "scopes":[ | |
| "{rootUrl}auth/dev", | |
| "{rootUrl}auth/dev/contact", | |
| "{rootUrl}auth/dev/contact.readonly" | |
| ] | |
| }, | |
| "head":{ | |
| "id":"contact-id.head", | |
| "path":"contact/{contact-id}", | |
| "httpMethod":"HEAD", | |
| "description":"Returns the HTTP Header as if you made a GET request for a single Contact record, but will not return any response body.", | |
| "parameters":{ | |
| "contact-id":{ | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647" | |
| } | |
| }, | |
| "parameterOrder":[ | |
| "contact-id" | |
| ], | |
| "scopes":[ | |
| "{rootUrl}auth/dev", | |
| "{rootUrl}auth/dev/contact", | |
| "{rootUrl}auth/dev/contact.readonly" | |
| ] | |
| }, | |
| "insert":{ | |
| "id":"contact-id.insert", | |
| "path":"contact", | |
| "httpMethod":"POST", | |
| "description":"Add a single Contact record.", | |
| "request":{ | |
| "ref$":"Contact" | |
| }, | |
| "response":{ | |
| "ref$":"Contact" | |
| }, | |
| "scopes":[ | |
| "{rootUrl}auth/dev", | |
| "{rootUrl}auth/dev/contact" | |
| ] | |
| }, | |
| "list":{ | |
| "id":"contact-id.list", | |
| "path":"contact", | |
| "httpMethod":"GET", | |
| "description":"Returns a list of Contact records.", | |
| "parameters":{ | |
| "maxResults":{ | |
| "type":"integer", | |
| "description":"Maximum number of entries returned on one result page. Optional.", | |
| "format":"int32", | |
| "minimum":"1", | |
| "location":"query" | |
| }, | |
| "q":{ | |
| "type":"string", | |
| "description":"Free text search terms to find events that match these terms in any field. Optional.", | |
| "location":"query" | |
| }, | |
| "pageToken":{ | |
| "type":"string", | |
| "description":"Token specifying which result page to return. Optional.", | |
| "location":"query" | |
| } | |
| }, | |
| "response":{ | |
| "ref$":"ContactListItem" | |
| }, | |
| "scopes":[ | |
| "{rootUrl}auth/dev", | |
| "{rootUrl}auth/dev/contact", | |
| "{rootUrl}auth/dev/contact.readonly" | |
| ] | |
| }, | |
| "listhead":{ | |
| "id":"contact-id.listhead", | |
| "path":"contact", | |
| "httpMethod":"HEAD", | |
| "description":"Returns the HTTP Header as if you made a GET request for a list of Contact records, but will not return any response body.", | |
| "parameters":{ | |
| "maxResults":{ | |
| "type":"integer", | |
| "description":"Maximum number of entries returned on one result page. Optional.", | |
| "format":"int32", | |
| "minimum":"1", | |
| "location":"query" | |
| }, | |
| "q":{ | |
| "type":"string", | |
| "description":"Free text search terms to find events that match these terms in any field. Optional.", | |
| "location":"query" | |
| }, | |
| "pageToken":{ | |
| "type":"string", | |
| "description":"Token specifying which result page to return. Optional.", | |
| "location":"query" | |
| } | |
| }, | |
| "scopes":[ | |
| "{rootUrl}auth/dev", | |
| "{rootUrl}auth/dev/contact", | |
| "{rootUrl}auth/dev/contact.readonly" | |
| ] | |
| }, | |
| "patch":{ | |
| "id":"contact-id.patch", | |
| "path":"contact/{contact-id}", | |
| "httpMethod":"PATCH", | |
| "description":"Modifies a single Contact record. This method supports JSON-Patch semantics.", | |
| "parameters":{ | |
| "contact-id":{ | |
| "type":"integer", | |
| "format":"uint32", | |
| "minimum":"1", | |
| "maximum":"2147483647" | |
| } | |
| }, | |
| "parameterOrder":[ | |
| "contact-id" | |
| ], | |
| "request":{ | |
| "ref$":"Contact" | |
| }, | |
| "response":{ | |
| "ref$":"Contact" | |
| }, | |
| "scopes":[ | |
| "{rootUrl}auth/dev", | |
| "{rootUrl}auth/dev/contact" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment