RefIDS in SIF

The RefId attribute of each object is vitally important in SIF, as it guarantees that an object is uniquely identified, and can be uniquely referenced by other objects. All SIF objects must contain a RefId attribute in order to be valid.

As specified in the current SIF Infrastructure Base Architecture (ยง5.12 Create), consumers are expected to provide RefIds they wish to see used in the body of the objects they POST or PUT under SIF. This is mandatory for a payload with multiple objects, and is strongly suggested for a payload with a single object. (The Javascript client incorporated into HITS will validate any POST requests for objects, and it will use a dummy RefId value if one is not included in the payload body.)

The SIF server will return an advisoryId element in the response to the request, linking the RefId specified for each object to the RefId actually assigned by the server. The server is entitled to overrule the RefId suggestion of the client, unless the mustUseAdvisory header has been supplied in the HTTP request. In the latter case, the Create request will be rejected by the server if the provided RefId is unacceptable to the server.

CopyrightNSIP 2015 - 2017 under theApache 2.0 license  Privacy