Version: v4.6

Named File Collections

Note: The nsfilter (namespace filter) query parameter is mandatory for every request. It sets the context, helping you look up resources within that namespace. Example: GET /itemsvc/api/v1/nameduseritems?nsfilter=proj_DrZrSNrW

Create Named File Collections#

Endpoints#

POST /itemsvc/api/v1/nameduseritems

Request#

Query#

Parameter	Type	Description	Required
`transactional`	Object	Set to true to process the request transactional.	Optional
`nsfilter`	String	namespace context	Required

Request body#

Parameter	Type	Description	Required
`_name`	String	Readable long-form name	Required
`_shortName`	String	An abbreviated name up to 22 characters that is used for reference	Required
`_description`	String	Describes the purpose of the NamedFileCollection	Required
`_itemClass`	String	Enter `"NamedFileCollection"`.	Required
`_namespaces`	String	An array of namespaces you want to add the NamedFileCollection to	Required
`_userType`	String	A user-defined type for the NamedFileCollection that you can use to distinguish or group it by.	Required

Request body example#

[  {    "_name": "ATM Def Collection",    "_shortName": "ATM Def Collection",    "_description": "ATM Def Collection",    "_itemClass": "NamedFileCollection",    "_namespaces": [      "dgdfg_h2xdEg7S"    ],    "_userType": "iaf_dt_type_map_defs_coll",    "_version": {      "_userAttributes": {        "path": "/"      }    }  }]

Response#

Response codes#

Code	Description
`201`	Created
`400`	Bad Request

Response data#

{  "_pageSize": 1,  "_list": [    {      "_uri": "/nameduseritems/5d8b355bf3e20c52ec935146",      "_name": "ATM Def Collection",      "_userType": "iaf_dt_type_map_defs_coll",      "_tipId": "5d8b355bf3e20c52ec935147",      "_versions": [        {          "_userAttributes": {            "path": "/"          },          "_userItemDbId": "5d8b355bf3e20c52ec935146",          "_id": "5d8b355bf3e20c52ec935147",          "_isTip": true,          "_metadata": {            "_updatedById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",            "_createdAt": 1569404251843,            "_createdById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",            "_updatedAt": 1569404251843          },          "_version": 1        }      ],      "_irn": "itemsvc:nameduseritem:5d8b355bf3e20c52ec935146",      "_namespaces": [        "dgdfg_h2xdEg7S"      ],      "_nextVersion": 2,      "_shortName": "ATM Def Collection",      "_tipVersion": 1,      "_versionsCount": 1,      "_itemClass": "NamedFileCollection",      "_userItemId": "atm def collection_Ji0hs6ElhK",      "_id": "5d8b355bf3e20c52ec935146",      "_description": "ATM Def Collection",      "_metadata": {        "_updatedById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",        "_createdAt": 1569404251841,        "_createdById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",        "_updatedAt": 1569404251841      },      "_kind": "collection"    }  ],  "_offset": 0,  "_total": 1}

Get Named File Collections#

Optionally filtered by query

Endpoints#

GET /itemsvc/api/v1/nameduseritems

Request#

Query parameters#

Parameter	Type	Description	Required
`query`	Object	Pass a query object with query parameters and values based on the NamedFileCollection class. You can also use query operators. To query all versions of NamedFileCollection rather than just the latest versions, add the query property and value `_versions.all: true`. For query examples, see Query parameter examples.	Optional
`project`	Object	Field projections to exclude or include fields in the response, for example, `project={"_metadata":0}`.	Optional
`page`	Object	Pass a Page object that defines the response pagination, for example, `?page={"_offset": 0, "_pageSize" 100}`	Optional
`sort`	Object	Pass a sort object to define the response sort order by a given property, using `1` for ascending sort and `-1` for descending sort, for example, `?sort={"_name":1}`	Optional
`userItemVersionId`	Object	Lookup RelatedItems for a given NamedUserCollection version, rather than the current version.	Optional
`nsfilter`	String	namespace context	Required

Request examples#

// Search by name for the tip versions only?query={"_name": "General Medical Architecture"}
// Search by _itemClass including all versions?query={"_itemClass": "NamedFileCollection","_versions.all":true}
// Search all versions and returns all matching versions ?query={"$and": [{"_itemClass": "NamedFileCollection"},{"_versions._userAttributes.key":"value"}],"_versions.all":true}
// Search by latest version?query={"$and": [{"_itemClass": "NamedFileCollection"},{"_versions._userAttributes.key":"value":"value"}]}

Response#

Response codes#

Code	Description
`200`	Success
`400`	Bad Request

Response data#

{  "_pageSize": 2,  "_list": [    {      "_uri": "/nameduseritems/5d8b3525f3e20c52ec935144",      "_name": "ATM Def Collection",      "_userType": "iaf_dt_type_map_defs_coll",      "_tipId": "5d8b3525f3e20c52ec935145",      "_versions": [        {          "_userItemDbId": "5d8b3525f3e20c52ec935144",          "_id": "5d8b3525f3e20c52ec935145",          "_isTip": true,          "_metadata": {            "_updatedById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",            "_createdAt": 1569404197382,            "_createdById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",            "_updatedAt": 1569404197382          },          "_version": 1        }      ],      "_irn": "itemsvc:nameduseritem:5d8b3525f3e20c52ec935144",      "_namespaces": [        "dgdfg_h2xdEg7S"      ],      "_nextVersion": 2,      "_shortName": "ATM Def Collection",      "_tipVersion": 1,      "_versionsCount": 1,      "_itemClass": "NamedFileCollection",      "_userItemId": "atm def collection_AhVOnM5cxJ",      "_id": "5d8b3525f3e20c52ec935144",      "_description": "ATM Def Collection",      "_metadata": {        "_updatedById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",        "_createdAt": 1569404197381,        "_createdById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",        "_updatedAt": 1569404197381      },      "_kind": "collection"    },    {      "_uri": "/nameduseritems/5d8b355bf3e20c52ec935146",      "_name": "ATM Def Collection",      "_userType": "iaf_dt_type_map_defs_coll",      "_tipId": "5d8b355bf3e20c52ec935147",      "_versions": [        {          "_userAttributes": {            "path": "/"          },          "_userItemDbId": "5d8b355bf3e20c52ec935146",          "_id": "5d8b355bf3e20c52ec935147",          "_isTip": true,          "_metadata": {            "_updatedById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",            "_createdAt": 1569404251843,            "_createdById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",            "_updatedAt": 1569404251843          },          "_version": 1        }      ],      "_irn": "itemsvc:nameduseritem:5d8b355bf3e20c52ec935146",      "_namespaces": [        "dgdfg_h2xdEg7S"      ],      "_nextVersion": 2,      "_shortName": "ATM Def Collection",      "_tipVersion": 1,      "_versionsCount": 1,      "_itemClass": "NamedFileCollection",      "_userItemId": "atm def collection_Ji0hs6ElhK",      "_id": "5d8b355bf3e20c52ec935146",      "_description": "ATM Def Collection",      "_metadata": {        "_updatedById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",        "_createdAt": 1569404251841,        "_createdById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",        "_updatedAt": 1569404251841      },      "_kind": "collection"    }  ],  "_offset": 0,  "_total": 2}

Get Named File Collections by Id#

Endpoints#

GET /itemsvc/api/v1/nameduseritems/{id}

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` or `_userItemId` value.	Required
`versions`	String	Gets the versions of a specific NamedFileCollection. To get a specific version, pass the version's id.	Optional

Query parameters#

Parameter	Type	Description	Required
`project`	String	Field projections to exclude or include fields in the response, for example, `project={"_metadata":0}`.	Optional
`_versions.all`	Boolean	Returns all versions of the NamedFileCollection, not just the latest version.	Optional
`nsfilter`	String	namespace context	Required

Response#

Response codes#

Code	Description
`200`	Success
`400`	Bad Request

Response data#

{  "_uri": "/nameduseritems/5d8b355bf3e20c52ec935146",  "_name": "ATM Def Collection",  "_userType": "iaf_dt_type_map_defs_coll",  "_tipId": "5d8b355bf3e20c52ec935147",  "_versions": [    {      "_userAttributes": {        "path": "/"      },      "_userItemDbId": "5d8b355bf3e20c52ec935146",      "_id": "5d8b355bf3e20c52ec935147",      "_isTip": true,      "_metadata": {        "_updatedById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",        "_createdAt": 1569404251843,        "_createdById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",        "_updatedAt": 1569404251843      },      "_version": 1    }  ],  "_irn": "itemsvc:nameduseritem:5d8b355bf3e20c52ec935146",  "_namespaces": [    "dgdfg_h2xdEg7S"  ],  "_nextVersion": 2,  "_shortName": "ATM Def Collection",  "_tipVersion": 1,  "_versionsCount": 1,  "_itemClass": "NamedFileCollection",  "_userItemId": "atm def collection_Ji0hs6ElhK",  "_id": "5d8b355bf3e20c52ec935146",  "_description": "ATM Def Collection",  "_metadata": {    "_updatedById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",    "_createdAt": 1569404251841,    "_createdById": "ebb6d8c2-f271-4eb8-8749-6517d44f80dd",    "_updatedAt": 1569404251841  },  "_kind": "collection"}

Delete Named File Collection by Id#

Endpoints#

DELETE /itemsvc/api/v1/nameduseritems/{id}

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` or `_userItemId` value.	Required

Request#

Query#

Parameter	Type	Description	Required
`transactional`	Boolean	Set to true to make the request transactional.	Optional
`nsfilter`	String	namespace context	Required

Response#

Response codes#

Code	Description
`204`	No Content

Response data#

None

Create FileItems in a Named File Collection#

Endpoints#

POST /itemsvc/api/v1/nameduseritems/{id}/relateditems

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` or `_userItemId` value.	Required

Query parameters#

Parameter	Type	Description	Required
`userItemVersionId`	String	Pass the userItemVersionId to target a specific NamedFileCollection version.	Optional
`transactional`	Object	Set to true to process the request transactional.	Optional
`nsfilter`	String	namespace context	Required

Body parameters#

Parameter	Type	Description	Required
`_related`	Array of Relationship	Array of Relationship objects to create with the NamedFileCollection as the parent and the _relationships array containing references to child FileItems.	Optional
`_fileId`	String	File id from the File Service	Required
`_fileVersionId`	String	File version id from the File Service	Optional

Body example#

[  {    "filename": "052dd171-39e4-4d68-9abb-ad5a51ea26ff.svg",    "srcId": "052dd171-39e4-4d68-9abb-ad5a51ea26ff",    "aspect": "View2d",    "_id": "5a5c3a65dc4789a701129e44",    "encoding": [      "UTF8"    ],    "contentType": "image/svg+xml",    "_fileId": 11,    "_fileVersionId": 56  }]

Response#

Response codes#

Code	Description
`201`	Created
`400`	Bad Request

Response data#

{  "_pageSize": 1,  "_list": [    {      "_guid": "7a7d723f-3a30-4511-9823-8a56fb48276a",      "_fileRepositoryId": 10,      "filename": "052dd171-39e4-4d68-9abb-ad5a51ea26ff.svg",      "srcId": "052dd171-39e4-4d68-9abb-ad5a51ea26ff",      "aspect": "View2d",      "_id": "5a5c3a65dc4789a701129e44",      "encoding": [        "UTF8"      ],      "contentType": "image/svg+xml",      "_fileId": 11,      "_fileVersionId": 56,      "_metadata": {        "_updatedById": "d73abe56-b1a8-489a-9020-eb0bb1af4660",        "_createdByName": "Amogh Chitnis",        "_createdAt": 1504696350504,        "_updatedByName": "Amogh Chitnis",        "_createdById": "d73abe56-b1a8-489a-9020-eb0bb1af4660",        "_updatedAt": 1504696350504      }    }  ],  "_offset": 0,  "_total": 1,  "_includeTotal": false}

Create File Items in a Named File Collection in Bulk#

Endpoints#

POST /itemsvc/api/v1/nameduseritems/{id}/relateditems/bulk

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` or `_userItemId` value.	Required

Query parameters#

Parameter	Type	Description	Required
`userItemVersionId`	String	Pass the NamedFileCollection `userItemVersionId` if you want to add to a specific version.	Optional
`transactional`	Boolean	Set to true to make the request transactional.	Optional
`nsfilter`	String	namespace context	Required

Body#

Add FileItems in bulk with a maximum body size of 10MB.

Body parameters#

Parameter	Type	Description	Required
`_related`	Array of Relationship	Array of Relationship objects to create with this FileItem as the parent and the `_related` array containing references to children.	Optional
`_fileRepositoryId`	String	The file repository id in the File Service
`_fileId`	String	The source file's File class id in the File Service
`_fileVersionId`	String	The file version's id in the File Service

Body example#

[  {    "_fileRepositoryId": 10,    "filename": "052dd171-39e4-4d68-9abb-ad5a51ea26ff.svg",    "srcId": "052dd171-39e4-4d68-9abb-ad5a51ea26ff",    "aspect": "View2d",    "_id": "5a5c3a65dc4789a701129e44",    "encoding": [      "UTF8"    ],    "contentType": "image/svg+xml",    "_fileId": 11,    "_fileVersionId": 56  }]

Response#

Response codes#

Code	Description
`201`	Created
`202`	Accepted
`400`	Bad Request

Response header#

Contains a URL to poll the status of the request.

Get File Items in a Named File Collection#

Endpoints#

GET /itemsvc/api/v1/nameduseritems/{id}/relateditems

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` value.	Required

Query parameters#

Parameter	Type	Description	Required
`query`	Object	Pass a query object with query parameters and values based on the FileItem class. You can also use query operators. For query examples, see Query parameter examples.	Optional
`project`	Object	Field projections to exclude or include fields in the response, for example, `project={"_metadata":0}`.	Optional
`page`	Object	Pass a Page object that defines the response pagination, for example, `?page={"_offset": 0, "_pageSize" 100}`	Optional
`sort`	Object	Pass a sort object to define the response sort order by a given property, using `1` for ascending sort and `-1` for descending sort, for example, `?sort={"_name":1}`	Optional
`userItemVersionId`	Object	Lookup RelatedItems for a given NamedUserCollection version, rather than the current version.	Optional
`nsfilter`	String	namespace context	Required

Request example#

GET /itemsvc/api/v1/nameduseritems/5cee7fee6505d6286dbca469/relateditems/?query={"name": "item1"}

Response#

Response codes#

Code	Description
`200`	Success
`400`	Bad Request
`404`	File Not Found

Response data#

{  "_pageSize": 1,  "_list": [    {      "_guid": "7a7d723f-3a30-4511-9823-8a56fb48276a",      "filename": "052dd171-39e4-4d68-9abb-ad5a51ea26ff.svg",      "srcId": "052dd171-39e4-4d68-9abb-ad5a51ea26ff",      "aspect": "View2d",      "_id": "5a5c3a65dc4789a701129e44",      "encoding": [        "UTF8"      ],      "contentType": "image/svg+xml",      "_fileId": 11,      "_fileVersionId": 56,      "_metadata": {        "_updatedById": "d73abe56-b1a8-489a-9020-eb0bb1af4660",        "_createdByName": "Amogh Chitnis",        "_createdAt": 1504696350504,        "_updatedByName": "Amogh Chitnis",        "_createdById": "d73abe56-b1a8-489a-9020-eb0bb1af4660",        "_updatedAt": 1504696350504      }    }  ],  "_offset": 0,  "_total": 1,  "_includeTotal": false}

Update a File Item by Id#

Endpoints#

PUT /itemsvc/api/v1/nameduseritems/{id}/relateditems/{fileItemId}

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedUserCollection `_id` or `_userItemId` value.	Required
`fileItemId`	String	Pass the FileItem `_id` value.	Required

Query parameters#

Parameter	Type	Description	Required
`userItemVersionId`	String	Pass the FileItem `userItemVersionId` if you want to update a specific version.	Optional
`transactional`	String	Set to true to make the request transactional.	Optional
`nsfilter`	String	namespace context	Required

Body#

This API replaces the existing object in the database.

Parameter	Type	Description	Required
`_fileRepositoryId`	String	File Repository ID from the File Service	Required
`_fileId`	String	File id in the File Service	Required
`_fileVersionId`	String	File version id from the File Service	Optional

Body example#

{  "_guid": "7a7d723f-3a30-4511-9823-8a56fb48276a",  "_fileRepositoryId": 10,  "filename": "052dd171-39e4-4d68-9abb-ad5a51ea26ff.svg",  "srcId": "052dd171-39e4-4d68-9abb-ad5a51ea26ff",  "aspect": "View2d",  "_id": "5a5c3a65dc4789a701129e44",  "encoding": [    "UTF8"  ],  "contentType": "image/svg+xml",  "_fileId": 11,  "_fileVersionId": 56,  "_metadata": {    "_updatedById": "d73abe56-b1a8-489a-9020-eb0bb1af4660",    "_createdByName": "John Doe",    "_createdAt": 1504696350504,    "_updatedByName": "John Doe",    "_createdById": "d73abe56-b1a8-489a-9020-eb0bb1af4660",    "_updatedAt": 1504696350504  }}

Response#

Response codes#

Code	Description
`200`	Success
`400`	Bad Request
`404`	File Not Found

Response data#

{  "_guid": "7a7d723f-3a30-4511-9823-8a56fb48276a",  "_fileRepositoryId": 10,  "filename": "052dd171-39e4-4d68-9abb-ad5a51ea26ff.svg",  "srcId": "052dd171-39e4-4d68-9abb-ad5a51ea26ff",  "aspect": "View2d",  "_id": "5a5c3a65dc4789a701129e44",  "encoding": [    "UTF8"  ],  "contentType": "image/svg+xml",  "_fileId": 11,  "_fileVersionId": 56,  "_metadata": {    "_updatedById": "d73abe56-b1a8-489a-9020-eb0bb1af4660",    "_createdByName": "Amogh Chitnis",    "_createdAt": 1504696350504,    "_updatedByName": "Amogh Chitnis",    "_createdById": "d73abe56-b1a8-489a-9020-eb0bb1af4660",    "_updatedAt": 1504696350504  }}

Delete a File Item in a Named File Collection by Id#

Endpoints#

DELETE /itemsvc/api/v1/nameduseritems/{id}/relateditems/{relatedItemId}

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` or `_userItemId` value.	Required
`relatedItemId`	String	Pass the FileItem `_id` or `_userItemId` value.	Required

Query parameters#

Parameter	Type	Description	Required
`userItemVersionId`	String	Pass the RelatedItem `userItemVersionId` if you want to delete a specific version.	Optional
`transactional`	String	Set to true to make the request transactional.	Optional
`nsfilter`	String	namespace context	Required

Response#

Response codes#

Code	Description
`204`	No Content
`404`	File Not Found

Response data#

None

Add Relationships For File Items in Named File Collection#

Adds relationships between FileItems in one NamedFileCollection to RelatedItems or FileItems in other NamedUserCollections or NamedFileCollections.

Endpoints#

PUT /itemsvc/api/v1/nameduseritems/{id}/relationships

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` or `_userItemId` value.	Required

Query parameters#

Parameter	Type	Description	Required
`userItemVersionId`	String	Pass the RelatedItem `userItemVersionId` if you want to update a specific version.	Optional
`transactional`	String	Set to true to make the request transactional.	Optional
`nsfilter`	String	namespace context	Required

Body parameters#

Parameter	Type	Description	Required
`_relatedUserItemId`	String	Pass the NamedUserCollection or NamedFileCollection's `_userItemId` value of the collection that contains the RelatedItems or FileItems.	`_relatedUserItemId` or `_relatedUserItemDbId`
`_relatedUserItemDbId`	String	Pass the NamedUserCollection or NamedFileCollection's `_id` value of the collection that contains the RelatedItems or FileItems.	`_relatedUserItemId` or `_relatedUserItemDbId`
`_relatedToIds`	Array of String	Array of the child FileItem or RelatedItem ids	Required
`_relatedFromId`	String	The parent FileItem's id	Required

Body example#

[  {    "_relatedFromId": "59afd8a1bae18c0223478bfe",    "_relatedUserItemDbId": "59afd8a1bae18c0223448eb3",    "_relatedToIds": [      "59afd92fbae18c0223448eb5",      "59afd92fbae18c0223448eb6",      "59afd92fbae18c0223448eb7"    ]  }]

Response#

Response codes#

Code	Description
`204`	No Content
`400`	Bad Request

Response data#

None

Bulk Add Relationships For File Items in Named File Collection#

Adds relationships between FileItems in one NamedFileCollection to RelatedItem or FileItem class objects in other NamedFileCollection or NamedUserCollection class objects

Endpoints#

PUT /itemsvc/api/v1/nameduseritems/{id}/relationships/bulk

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` or `_userItemId` value for the collection you want to create the FileItems in.	Required

Query parameters#

Parameter	Type	Description	Required
`userItemVersionId`	String	Add RelatedItems to a specific version.	Optional
`transactional`	String	Set to true to make the request transactional.	Optional
`nsfilter`	String	namespace context	Required

Body parameters#

Parameter	Type	Description	Required
`_relatedUserItemId`	String	Pass the NamedUserCollection or NamedFileCollection's `_userItemId` value of the collection that contains the FileItems or RelatedItems.	`_relatedUserItemId` or `_relatedUserItemDbId`
`_relatedUserItemDbId`	String	Pass the NamedUserCollection or NamedFileCollection's `_id` value of the collection that contains the FileItems or RelatedItems.	`_relatedUserItemId` or `_relatedUserItemDbId`
`_relatedToIds`	Array of String	Array of the child FileItem or RelatedItem ids that form the child related items
`_relatedFromId`	String	The parent FileItem's id

Body example#

[  {    "_relatedFromId": "59afd8a1bae18c0223478bfe",    "_relatedUserItemDbId": "59afd8a1bae18c0223448eb3",    "_relatedToIds": [      "59afd92fbae18c0223448eb5",      "59afd92fbae18c0223448eb6",      "59afd92fbae18c0223448eb7"    ]  }]

Response#

Response codes#

Code	Description
`202`	Accepted
`400`	Bad Request
`404`	File Not Found

Response header#

Contains a URL to poll the status of the request

Get Relationships in a Named File Collection#

Filtered by Query

Endpoints#

GET /itemsvc/api/v1/nameduseritems/{id}/relationships

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` or `_userItemId` value.	Required

Query parameters#

Parameter	Type	Description	Required
`query`	Object	Pass a query object with query parameters and values based on the FileItem class. You can also use query operators. For query examples, see Query parameter examples. Add `_versions.all: true` to search all versions	Optional
`project`	Object	Field projections to exclude or include fields in the response, for example, `project={"_metadata":0}`.	Optional
`page`	Object	Pass a Page object that defines the response pagination, for example, `?page={"_offset": 0, "_pageSize" 100}`	Optional
`sort`	Object	Pass a sort object to define the response sort order by a given property, using `1` for ascending sort and `-1` for descending sort, for example, `?sort={"_name":1}`	Optional
`userItemVersionId`	Object	Lookup items for a given collection version, rather than the current version.	Optional
`nsfilter`	String	namespace context	Required

Response#

Response codes#

Code	Description
`200`	Success
`400`	Bad Request

Response body#

{  "_pageSize": 2,  "_list": [    {      "_relatedFromId": "59eeb597a7b11b00011902f5",      "_relatedToIds": [        "59eeb597a7b11b0001190b75",        "59eeb597a7b11b0001190b76",        "59eeb597a7b11b0001190b77",        "59eeb597a7b11b0001190b78",        "59eeb597a7b11b0001190b79",        "59eeb597a7b11b0001190b7a",        "59eeb597a7b11b0001190b7b",        "59eeb597a7b11b0001190b7c",        "59eeb597a7b11b0001190b7d",        "59eeb597a7b11b0001190b7e"      ],      "_relatedUserItemDbId": "59eeb597a7b11b0001190b73",      "_id": "59eeb597a7b11b0001190b7f",      "_relatedUserType": "bim_element_props",      "_relatedUserItemId": "gmaelemprops_ZRNujioXxE"    },    {      "_relatedFromId": "59eeb597a7b11b00011902f6",      "_relatedToIds": [        "59eeb597a7b11b0001190b8a",        "59eeb597a7b11b0001190b8b",        "59eeb597a7b11b0001190b8c",        "59eeb597a7b11b0001190b8d",        "59eeb597a7b11b0001190b8e",        "59eeb597a7b11b0001190b8f",        "59eeb597a7b11b0001190b90",        "59eeb597a7b11b0001190b91",        "59eeb597a7b11b0001190b92",        "59eeb597a7b11b0001190b93"      ],      "_relatedUserItemDbId": "59eeb597a7b11b0001190b73",      "_id": "59eeb597a7b11b0001190b94",      "_relatedUserType": "bim_element_props",      "_relatedUserItemId": "gmaelemprops_ZRNujioXxE"    }  ],  "_offset": 0,  "_total": 2,  "_includeTotal": true}

Delete Relationship for a File Item#

Endpoints#

DELETE /itemsvc/api/v1/nameduseritems/{id}/relationships

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` or `_userItemId` value.	Required

Query#

Parameter	Type	Description	Required
`_relatedUserItemId`	String	Pass the NamedUserCollection or NamedFileCollection's `_id` value of the collection that contains the RelatedItems or FileItems.	`_relatedUserItemId` or `_relatedUserItemDbId`
`_relatedUserItemDbId`	String	Pass the NamedUserCollection or NamedFileCollection's `_id` value of the collection that contains the RelatedItems or FileItems.	`_relatedUserItemId` or `_relatedUserItemDbId`
`_relatedToIds`	Array of String	Array of the child RelatedItem or FileItem ids
`_relatedFromId`	String	The parent FileItem's id
`transactional`	String	The parent FileItem's id
`nsfilter`	String	namespace context	Required

Response#

Response codes#

Code	Description
`204`	No Content
`400`	Bad Request

Response data#

None

Get Update Logs for Named User Item#

Endpoints#

GET /itemsvc/api/v1/nameduseritems/{id}/updatelogs

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedFileCollection `_id` or `_userItemId` value.	Required

Query parameters#

Parameter	Type	Description	Required
`userItemVersionId`	String	Gets items for a given version.	Optional
`nsfilter`	String	namespace context	Required

Response#

Response codes#

Code	Description
`200`	Success
`404`	File Not Found

Response body#

[  {    "_updatedBy": "1b457660-92c2-461d-9895-78e731a031c6",    "_updatedAt": 1542267364347  }]

Get Update Logs for File Item#

Endpoints#

GET /itemsvc/api/v1/nameduseritems/{id}/relateditems/{fileItemId}/updatelogs

Request#

Path parameters#

Parameter	Type	Description	Required
`id`	String	Pass the NamedUserCollection `_id` or `_userItemId` value.	Required
`fileItemId`	String	Pass the FileItem's id.	Required

Query parameters#

Parameter	Type	Description	Required
`userItemVersionId`	String	Target a specific NamedUserCollection version.	Required
`nsfilter`	String	namespace context	Required

Response#

Response codes#

Code	Description
`200`	Success
`404`	File Not Found

Response body#

[  {    "_updatedBy": "1b457660-92c2-461d-9895-78e731a031c6",    "_updatedAt": 1542267364347  }]