2.2.3.50 documentlibrary:LinkId

The documentlibrary:LinkId element is an optional child element of the itemoperations:Fetch element in ItemOperations command requests and responses. The documentlibrary:LinkId element is a required child element of the search:EqualTo element in Search command requests and an optional child element of the search:Properties element in Search command responses. In all contexts, the documentlibrary:LinkId element specifies a Uniform Resource Identifier (URI) that is assigned by the server to certain resources, such as Windows SharePoint Services or UNC documents.

Command request/response

Parent elements

Child elements

Data type

Number allowed

ItemOperations command request (section 2.2.1.10) fetch operation

itemoperations:Fetch (section 2.2.3.67.1)

None

URI (as specified in [RFC3986])

0...1 (optional)

ItemOperations command response fetch operation

itemoperations:Fetch

None

URI

0...1 (optional)

Search command request (section 2.2.1.16)

search:EqualTo (section 2.2.3.62)

None

URI

1...1 (required)

Search command response

search:Properties (section 2.2.3.139.3)

None

URI

0...1 (optional)

The client MUST store the documentlibrary:LinkId element value that is retrieved by the Search command (section 2.2.1.16) if the client will send requests using the documentlibrary:LinkId element value in the future. In an ItemOperations command request, the documentlibrary:LinkId element can be used by the itemoperations:Fetch element to refer to the location of an item.

Protocol Versions

The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.

Protocol version

Element support, ItemOperations

Element support, Search

2.5

12.0

Yes

Yes

12.1

Yes

Yes

14.0

Yes

Yes

14.1

Yes

Yes

16.0

Yes

Yes

16.1

Yes

Yes