1.1 Glossary

This document uses the following terms:

Augmented Backus-Naur Form (ABNF): A modified version of Backus-Naur Form (BNF), commonly used by Internet specifications. ABNF notation balances compactness and simplicity with reasonable representational power. ABNF differs from standard BNF in its definitions and uses of naming rules, repetition, alternatives, order-independence, and value ranges. For more information, see [RFC5234].

base64 encoding: A binary-to-text encoding scheme whereby an arbitrary sequence of bytes is converted to a sequence of printable ASCII characters, as described in [RFC4648].

child item query: A set of filters and options for retrieving child objects in a collection of CSOM Objects.

Coordinated Universal Time (UTC): A high-precision atomic time standard that approximately tracks Universal Time (UT). It is the basis for legal, civil time all over the Earth. Time zones around the world are expressed as positive and negative offsets from UTC. In this role, it is also referred to as Zulu time (Z) and Greenwich Mean Time (GMT). In these specifications, all references to UTC refer to the time at UTC-0 (or GMT).

CSOM action: An individual method, property, or lookup operation that is performed by a protocol server in a request.

CSOM action list: A sequential list of CSOM actions that are defined in a CSOM request to be executed by a protocol server.

CSOM action response structure: A JavaScript Object Notation (JSON) data structure that contains an array of individual results from a protocol server in response to actions that were submitted by a protocol client.

CSOM array: An ordered collection of values that can be used in an XML request or JSON response text. The values are identified by their position and their position is determined by a zero-based integer index.

CSOM binary: An array of 8-bit, unsigned integers that can be used in an XML request or as a string in JSON response text.

CSOM Boolean: A Boolean value that can be used in an XML request or JSON response text. A CSOM Boolean value is either "true" or "false".

CSOM Byte: An 8-bit, unsigned integer value that represents the BYTE type, as described in [MS-DTYP]. The range of CSOM Byte values is 0-255 and it has different representations, depending on whether it is used in an XML request or JSON response text.

CSOM Char: A Unicode character value that can be used in an XML request or as a string in JSON response text.

CSOM DateTime: An Int64 value that represents the number of 100-nanosecond time intervals that have elapsed since 12:00:00, January 1, 0001. It can be used in an XML request or as a string in JSON response text. The value can represent time intervals through 23:59:59.9999999, December 31, 9999. It can also specify whether a local, UTC, or no time zone applies.

CSOM dictionary: An object that contains an unordered collection of key/value pairs that can be used in an XML request or JSON response text. Each key in a CSOM dictionary has a unique name.

CSOM Double: A 64-bit, double-precision, floating-point value, which is the DOUBLE type described in [MS-DTYP], that can be used in an XML request or as a number in JSON response text. The range of CSOM Double values is from "-1.79769313486232e308" to "1.79769313486232e308".

CSOM error: An object that contains information about an error that occurred on a protocol server when processing a request.

CSOM expando field: A field that stores data for an instance of a CSOM Object and is not defined explicitly in the corresponding CSOM Object type.

CSOM expression: A syntax that is used by protocol clients to express sets of actions to execute based on state data that is stored on a protocol server.

CSOM GUID: A GUID, as described in [MS-DTYP], that can be used in an XML request or as a string in JSON response text.

CSOM Int16: A 16-bit, signed integer value, which is the INT16 type described in [MS-DTYP], that can be used in an XML request or as a number in JSON response text. The range of CSOM Int16 values is from "-32768" to "32767".

CSOM Int32: A 32-bit, signed integer value, which is the INT32 type described in [MS-DTYP], that can be used in an XML request or as a number in JSON response text. The range of CSOM Int32 values is from "-2147483648" to "2147483647".

CSOM Int64: A 64-bit, signed integer value, which is the INT64 type described in [MS-DTYP], that can be used in an XML request or as a number in JSON response text. The range of CSOM Int64 values is from "-9223372036854775808" to "9223372036854775807".

CSOM method: A procedure that is executed by a protocol server for a CSOM Object.

CSOM Object: An object that contains a set of members, which are named values and methods. It has a Unicode string value, which is referred to as a CSOM type name, that identifies its type.

CSOM Object type: A reference to a standard definition of methods, properties, and behavior for a logical object in the SharePoint Client-Side Object Model.

CSOM property: A representation of a field of data that is stored for a type of CSOM Object.

CSOM SByte: An 8-bit, signed integer value, which is the INT8 type described in [MS-DTYP], that can be used in an XML request or as a number in JSON response text. The range of CSOM SByte values is from "-128" to "127".

CSOM Single: A 32-bit, single-precision, floating-point value, which is the FLOAT type described in [MS-DTYP], that can be used in an XML request or as a number in JSON response text. The range of CSOM Single values is from "-3.402823e38" to "3.402823e38".

CSOM String: A representation of text as a series of Unicode characters. It can be used in an XML request or JSON response text.

CSOM type: A predefined set of named values that enable a protocol client to access standard descriptions of exposed objects, members, and enumerations. A CSOM type can be a CSOM Object type, CSOM value object type, or CSOM enumeration.

CSOM type identifier: A GUID that is used to identify a CSOM type.

CSOM type name: A Unicode string that identifies the type of a CSOM Object.

CSOM UInt16: A 16-bit, unsigned integer value, which is the UINT16 type described in [MS-DTYP], that can be used in an XML request or as a number in JSON response text. The range of CSOM UInt16 values is from "0" to "65535".

CSOM UInt32: A 32-bit, unsigned integer value, which is the UINT32 type described in [MS-DTYP], that can be used in an XML request or as a number in JSON response text. The range of CSOM UInt32 values is from "0" to "4294967295".

CSOM UInt64: A 64-bit, unsigned integer value, which is the UINT64 type described in [MS-DTYP], that can be used in an XML request or as a number in JSON response text. The range of CSOM UInt64 values is from "0" to "18446744073709551615".

CSOM value object: An object that contains a set of named values, which are referred to as members. It has a Unicode string value, referred to as a CSOM type name, that identifies its type.

CSOM value object type: A CSOM type that contains a set of named values, which are referred to as members. It has type information, which is identified by a Unicode string, and is associated with a specific identifier, which is a CSOM GUID.

default scalar property set: A set of properties that are retrieved by default for an object. The properties map to fields in a storage schema.

expression: A combination of operators, symbols, constants, literal values, functions, names of fields or columns, controls, and properties that evaluates to a single value.

globally unique identifier (GUID): A term used interchangeably with universally unique identifier (UUID) in Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the value. Specifically, the use of this term does not imply or require that the algorithms described in [RFC4122] or [C706] must be used for generating the GUID. See also universally unique identifier (UUID).

Hypertext Transfer Protocol (HTTP): An application-level protocol for distributed, collaborative, hypermedia information systems (text, graphic images, sound, video, and other multimedia files) on the World Wide Web.

Hypertext Transfer Protocol Secure (HTTPS): An extension of HTTP that securely encrypts and decrypts web page requests. In some older protocols, "Hypertext Transfer Protocol over Secure Sockets Layer" is still used (Secure Sockets Layer has been deprecated). For more information, see [SSL3] and [RFC5246].

JavaScript Object Notation (JSON): A text-based, data interchange format that is used to transmit structured data, typically in Asynchronous JavaScript + XML (AJAX) web applications, as described in [RFC7159]. The JSON format is based on the structure of ECMAScript (Jscript, JavaScript) objects.

Multipurpose Internet Mail Extensions (MIME): A set of extensions that redefines and expands support for various types of content in email messages, as described in [RFC2045], [RFC2046], and [RFC2047].

object identity: An optional, implementation-specific string that uniquely identifies a CSOM Object. It can be used in queries to retrieve a specific CSOM object.

object path: A string that is used to access namespaces, classes, objects, and instances. Each object on a system has a unique path that identifies it locally or over a network.

queryable expression: A syntax that is used by protocol clients to retrieve a set of CSOM Objects that meet a specific set of criteria, based on state data that is stored on a protocol server.

Request-URI: A URI in an HTTP request message, as described in [RFC2616].

Status-Code: A 3-digit integer result code in an HTTP response message, as described in [RFC2616].

Unicode: A character encoding standard developed by the Unicode Consortium that represents almost all of the written languages of the world. The Unicode standard [UNICODE5.0.0/2007] provides three forms (UTF-8, UTF-16, and UTF-32) and seven schemes (UTF-8, UTF-16, UTF-16 BE, UTF-16 LE, UTF-32, UTF-32 LE, and UTF-32 BE).

URL encode: The process of encoding characters that have reserved meanings for a Uniform Resource Locator (URL), as described in [RFC1738].

Web Services Description Language (WSDL): An XML format for describing network services as a set of endpoints that operate on messages that contain either document-oriented or procedure-oriented information. The operations and messages are described abstractly and are bound to a concrete network protocol and message format in order to define an endpoint. Related concrete endpoints are combined into abstract endpoints, which describe a network service. WSDL is extensible, which allows the description of endpoints and their messages regardless of the message formats or network protocols that are used.

website: A group of related pages and data within a SharePoint site collection. The structure and content of a site is based on a site definition. Also referred to as SharePoint site and site.

XML: The Extensible Markup Language, as described in [XML1.0].

XML schema: A description of a type of XML document that is typically expressed in terms of constraints on the structure and content of documents of that type, in addition to the basic syntax constraints that are imposed by XML itself. An XML schema provides a view of a document type at a relatively high level of abstraction.

MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.