Data Types
  • 28 Jun 2023
  • 7 Minutos para leer
  • Colaboradores
  • Oscuro
    Ligero

Data Types

  • Oscuro
    Ligero

The content is currently unavailable in Spanish. You are viewing the default English version.
Resumen del artículo

Document


{
	"href": "Text"
	"dataType": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"documentId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"description": "Text"
	"releaseState": "0"
	"checkInStatus": "0"
	"revision": "0"
	"reviewDate": "Text"
	"expireDate": "Text"
	"archive": "0"
	"abstract": "Text"
	"keywords": "Text"
	"changeText": "Text"
	"folderId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"folderName": "Text"
	"folderPath": "Text"
	"fileId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fileName": "Text"
	"fileSize": "0"
	"extension": "Text"
	"contentType": "Text"
	"checkedInBy": "Text"
	"checkedOutById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"checkedOutBy": "Text"
	"checkOutDate": "Text"
	"createDate": "Text"
	"createById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createBy": "Text"
	"modifyDate": "Text"
	"modifyById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyBy": "Text"
}
		
ParameterTypeDescription
hrefstringThe url path.
dataTypestringData type of object.
idguidRevision Id of the Document.
documentIdguidDocument Id.
namestringDocument Name.
descriptionstringDescription of Document.
releaseStateintDocument release state.
  • Unreleased (0)
  • Released (1)
  • Pending (2)
checkInStatusintDocument check in status.
  • Checked In (0)
  • Checked Out (1)
revisionintDocument revision number.
reviewDatestringDate reviewed.
expireDatestringDate expires.
archiveintArchive status
  • Active (0)
  • Archived (1)
  • Deleted (2)
  • Purged (3)
abstractstringAbstract.
keywordsstringKeywords.
changeTextstringReason text changed.
folderIdguidFolder Id containing the document.
folderNamestringName of folder.
folderPathstringPath to folder.
fileIdguidFile Id.
fileNamestringFile Name.
fileSizeintSize of file in bytes.
extensionstringFile extension.
contentTypestringContent type of file.
checkedInBystringUser whom checked in file.
checkedOutByIdguidId of user whom checked out document.
checkedOutBystringUser whom checked out file.
checkOutDatestringDate document checked out.
createDatestringDate document created.
createByIdguidId of user whom created document.
createBystringUser whom created document.
modifyDatestringMost recent date that the document was modified.
modifyByIdguidId of user whom modified document.
modifyBystringUser whom modified document.


DocumentIndexField


{
	"href": "Text"
	"dataType": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"dhId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fieldId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fieldType": "0"
	"label": "Text"
	"description": "Text"
	"ordinalPosition": "0"
	"required": "true"
	"units": "Text"
	"value": "Text"
	"createDate": "Text"
	"createById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createBy": "Text"
	"modifyDate": "Text"
	"modifyById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyBy": "Text"
}
		
ParameterTypeDescription
hrefstringThe path to document.
dataTypestringData type of object.
idguidRevision Id of the Document.
dhIdguidRevision Id of the Document Index Field.
fieldIdguidDocument Index Field Id.
fieldTypeintThe data type of the index field.
  • MultiLineTextBox (0)
  • TextBox (1)
  • DatasourceDropDown (2)
  • AjaxTextBox (3)
  • Calendar (4)
  • Numeric (5)
  • DropDownList (6)
  • UsersDropDownList (7)
  • ModifiableDropDownList (8)
  • ModifiableDatasourceDropDown (9)
labelstringName of Document Index Field.
descriptionstringDescription of Document Index Field.
ordinalPositionintorder postion of indexfield displayed.
requiredbooleanTrue or False if Document Index Field is required for Document.
unitsstringUnits of Index Field.
valuestringValue of Document Index Field.
createDatestringDate Document Index Field created.
createByIdguidId of user whom created Document Index Field.
createBystringUser whom created Document Index Field.
modifyDatestringMost recent date that the Document Index Field was modified.
modifyByIdguidId of user whom modified Document Index Field.
modifyBystringUser whom modified Document Index Field.


Folder


{
	"href": "Text"
	"dataType": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"modifyDate": "Text"
	"modifyById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createDate": "Text"
	"createById": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"topLevelFolderId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"folderType": "0"
	"status": "0"
	"folderPath": "Text"
	"parentFolderId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
		
ParameterTypeDescription
hrefstringUrl path to folder.
dataTypestringDatatype.
idguidFolder Id.
namestringName of folder.
modifyDatestringThe date/time the folder was last modified.
modifyByIdguidId of the user whom modified the folder.
createDatestringThe date/time the folder was created.
createByIdguidThe Id of the user that created the folder.
topLevelFolderIdguidId of top level folder.
folderTypeintThe folder type.
  • Current Store (0)
  • Document Library (1)
  • Container (2)
  • Subcontainer (3)
  • Folder (4)
  • Template (5)
  • Not a folder (6)
statusintCurrent folder status.
  • Active (0)
  • Deleted (1)
folderPathstringThe path of the folder starting at the root of the document library. For example, '/General' or '/Attachments'.
parentFolderIdguidId of the parent folder.


FolderIndexField


{
	"href": "Text"
	"datatype": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"definitionpkey": "0"
	"folderid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fieldtype": "0"
	"label": "Text"
	"description": "Text"
	"ordinalposition": "0"
	"folderordinalposition": "0"
	"required": "true"
	"connectionid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"queryid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"querydisplayfield": "Text"
	"queryvaluefield": "Text"
	"dropdownlistid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"defaultvalue": "Text"
	"globalrequired": "true"
	"globalconnectionid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"globalqueryid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"globalqueryvaluefield": "Text"
	"globalquerydisplayfield": "Text"
	"globaldropdownlistid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"globaldefaultvalue": "Text"
	"createdate": "Text"
	"createbyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createby": "Text"
	"modifydate": "Text"
	"modifybyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyby": "Text"
}
		
ParameterTypeDescription
hrefstringThe path to document.
datatypestringData type of object.
idguidId of the Folder Index Field.
definitionpkeyintPrimary key.
folderidguidFolder Id.
fieldtypeintType of field.
  • MultiLineTextBox (0)
  • SingleLineTextBox (1)
  • DatasourceDropDown (2)
  • AjaxTextBox (3)
  • Calendar (4)
  • Numeric (5)
  • DropDownList (6)
  • UsersDropDownList (7)
  • ModifiableDropDownList (8)
  • ModifiableDatasourceDropDown (9)
labelstringName of Document Index Field.
descriptionstringDescription of Folder Index Field.
ordinalpositionintorder position displayed of Index Field.
folderordinalpositionintOrder position displayed of Index Field in folder.
requiredbooleanTrue or False if Folder Index Field is required for Document.
connectionidguidId of connection.
queryidguidId of query.
querydisplayfieldstringDisplay field type of query.
queryvaluefieldstringValue of field query.
dropdownlistidguidId of drop down list.
defaultvaluestringDefault value of Folder Index Field.
globalrequiredbooleanTrue or false if Folder Index Field is required.
globalconnectionidguidGlobal connection Id.
globalqueryidguidGlobal query Id.
globalqueryvaluefieldstringValue of global field query.
globalquerydisplayfieldstringDisplay field type of global query.
globaldropdownlistidguidId of drop down list globally.
globaldefaultvaluestringDefault value globally.
createdatestringDate Folder Index Field created.
createbyidguidId of user whom created Folder Index Field.
createbystringUser whom created Folder Index Field.
modifydatestringMost recent date that the Folder Index Field was modified.
modifybyidguidId of user whom modified Folder Index Field.
modifybystringUser whom modified Folder Index Field.


FormInstance


{
	"href": "Text"
	"datatype": "Text"
	"revisionid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"instancename": "Text"
	"modifydate": "Text"
	"modifybyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyby": "Text"
	"createdate": "Text"
	"createbyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createby": "Text"
}
		
ParameterTypeDescription
hrefstringURL path to object.
datatypestringObject type.
revisionidguidThe revision specific ID of the form instance.
instancenamestringThe name of the form instance.
modifydatestringThe date/time the form instance was last modified.
modifybyidguidThe ID of the user that last modified the form instance.
modifybystringThe display name of the user that last modified the form instance.
createdatestringThe date/time that the form instance was created.
createbyidguidThe ID of the user that create the form instance.
createbystringThe display name of the user that created the form instance.


FormTemplate


{
	"href": "Text"
	"datatype": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"modifydate": "2023-01-01"
	"modifybyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyby": "Text"
	"createdate": "2023-01-01"
	"createbyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createby": "Text"
	"description": "Text"
	"revisionid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"revision": "0"
	"templaterevision": "0"
	"status": "0"
}
		
ParameterTypeDescription
hrefstringThe url path.
datatypestringData type of object.
idguidRevision Id of the Form Template.
namestringForm Template Name.
modifydatedatetimeThe date/time the form template was last modified.
modifybyidguidThe ID of the user that last modified the form template.
modifybystringThe display name of the user that last modified the form template.
createdatedatetimeThe date/time the form template was created.
createbyidguidThe ID of the user that created the form template.
createbystringThe display name of the user that created the form template.
descriptionstringThe description of the form template.
revisionidguidThe revision specific ID of the form template.
revisionintCurrent revision of the form. Each time you revise a form, this number increases by one.
templaterevisionintRevision Number of Template.
statusintCurrent status of the form template.
  • CheckedIn (1)
  • CheckedOut (2)


Group


{
	"href": "Text"
	"datatype": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"description": "Text"
	"siteid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
		
ParameterTypeDescription
hrefstringThe url path.
datatypestringData type of object.
idguidThe Id of the group used.
namestringThe name of the group.
descriptionstringThe description of the group.
siteidguidThe Id of the site that the group belongs to.


IndexFieldDefinition


{
	"href": "Text"
	"datatype": "Text"
	"pkey": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fieldtype": "0"
	"label": "Text"
	"description": "Text"
	"required": "true"
	"connectionid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"queryid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"querydisplayfield": "Text"
	"queryvaluefield": "Text"
	"dropdownlistid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"defaultvalue": "Text"
	"createdate": "Text"
	"createbyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"createby": "Text"
	"modifydate": "Text"
	"modifybyid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"modifyby": "Text"
}
		
ParameterTypeDescription
hrefstringThe path to document.
datatypestringData type of object.
pkeyguidPrimary key.
idguidId of the Folder Index Field
fieldtypeintType of field.
  • MultiLineTextBox (0)
  • SingleLineTextBox (1)
  • DatasourceDropDown (2)
  • AjaxTextBox (3)
  • Calendar (4)
  • Numeric (5)
  • DropDownList (6)
  • UsersDropDownList (7)
  • ModifiableDropDownList (8)
  • ModifiableDatasourceDropDown (9)
labelstringName of Index Field Definition.
descriptionstringDescription of Index Field Definition.
requiredbooleanTrue or False if Index Field is required.
connectionidguidId of connection.
queryidguidId of query.
querydisplayfieldstringDisplay field type of query.
queryvaluefieldstringValue of field query.
dropdownlistidguidId of drop down list.
defaultvaluestringDefault value of Index Field Definition.
createdatestringDate Index Field Definition was created.
createbyidguidId of user whom created Index Field Definition.
createbystringUser whom created Index Field Definition.
modifydatestringMost recent date that the Index Field Definition was modified.
modifybyidguidId of user whom modified Index Field Definition.
modifybystringUser whom modified Index Field Definition.


IndexFieldSelectOption


{
	"href": "Text"
	"datatype": "Text"
	"display": "Text"
	"value": "Text"
}
		
ParameterTypeDescription
hrefstringThe url path.
datatypestringData type of object.
displaystringThe value displayed.
valuestringThe value stored.


Site


{
	"href": "Text"
	"datatype": "Text"
	"description": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"sitetype": "Text"
	"status": "Text"
}
		
ParameterTypeDescription
hrefstringThe url path.
datatypestringData type of object.
descriptionstringA description of the site.
idguidThe ID of the site, used in API calls.
namestringThe name of the site.
sitetypestringThe type of the site.
  • Location
  • Customer
  • Supplier
statusstringThe status of the site.
  • Open
  • Closed


User


{
	"href": "Text"
	"datatype": "Text"
	"id": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"name": "Text"
	"userid": "Text"
	"firstname": "Text"
	"middleinitial": "Text"
	"lastname": "Text"
	"passwordexpires": "2023-01-01"
	"useridexpires": "2023-01-01"
	"emailaddress": "Text"
	"siteid": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"useridneverexpires": "true"
	"passwordneverexpires": "true"
	"enabled": "true"
	"lastipaddress": "Text"
}
		
ParameterTypeDescription
hrefstringThe url path.
datatypestringData type of object.
idguidThe ID of the user, used in API calls.
namestringThe display name of the user.
useridstringThe username of the user.
firstnamestringThe first name of the user.
middleinitialstringThe middle initial of the user.
lastnamestringThe last name of the user.
passwordexpiresdatetimeThe date/time that the password of the user expires. Can be null.
useridexpiresdatetimeThe date/time that the UserID of the user expires and needs to be changed. Can be null.
emailaddressstringThe email address of the user.
siteidguidThe ID of the home site of the user.
useridneverexpiresboolTrue if the UserID never expires.
passwordneverexpiresboolTrue if the password never expires.
enabledboolTrue if the user is enabled.
lastipaddressstringThe last IP address that the user did a web login from.


IndexField


{
	"indexfield": "value"
	"indexfield2": "value"
	"indexfield3": "value"
}
		
ParameterTypeDescription
indexfieldvalueThe value of the index field.
indexfield2valueThe value of the index field.
indexfield3valueThe value of the index field.


DocumentList


{
	"dhDocId": "Text"
	"dhFilename": "Text"
	"dhId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
		
ParameterTypeDescription
dhDocIdstringDocument DhDocID.
dhFilenamestringThe name of the file.
dhIdguidDocument DhId


DhId


{
	"documentId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"documentId2": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"documentId3": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
		
ParameterTypeDescription
documentIdguidDhId of the document.
documentId2guidDhId of the document.
documentId3guidDhId of the document.


FileParameter


{
	"source": "Text"
	"command": "Text"
	"ocrStatus": "Text"
	"keepAnnotations": "true"
}
		
ParameterTypeDescription
sourcestring
commandstring
ocrStatusstring
keepAnnotationsbool


SecurityMemberApplyAction


{
	"memberID": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"memberType": "Text"
	"roleType": "Text"
	"action": "Text"
}
		
ParameterTypeDescription
memberIDguidThe member ID.
memberTypestringThe member type.
  • User
  • Group
roleTypestringThe role type.
  • None (0)
  • Owner (1)
  • Editor (2)
  • Publisher (3)
  • Viewer (4)
  • Member (5)
actionstringThe security action.
  • Add
  • Remove


DropDownQuery


{
	"fieldId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"fieldName": "Text"
	"parameterValue": "Text"
	"value": "Text"
	"type": "field"
}
		
ParameterTypeDescription
fieldIdguid
fieldNamestring
parameterValuestring
valuestring
typefield


FormTemplateCategoryRelation


{
	"relationId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"categoryId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"categoryName": "Text"
	"formTemplateId": "0a1b2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
	"formTemplateName": "Text"
	"formTemplateDescription": "Text"
}
		
ParameterTypeDescription
relationIdguid
categoryIdguid
categoryNamestring
formTemplateIdguid
formTemplateNamestring
formTemplateDescriptionstring


FormControlList


{
	"id1": "Text"
	"value1": "Text"
	"id2": "Text"
	"value2": "Text"
}
		
ParameterTypeDescription
id1string
value1string
id2string
value2string


FieldList


{
	"field": ""Value 1""
	"field2": ""Value 2""
	"field3": ""Value 3""
}
		
ParameterTypeDescription
fieldvalueThe value of the given field.
field2valueThe value of the given field.
field3valueThe value of the given field.


FillinMapping


{
	"targetId": "Text"
	"value": "Text"
	"text": "Text"
}
		
ParameterTypeDescription
targetIdstring
valuestring
textstring

¿Te ha sido útil este artículo?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy AI, que facilita el descubrimiento de conocimiento a través de la inteligencia conversacional