RemoteIdsApi (api 1.0.0 API)

All Known Subinterfaces:

ApplicationApi, AssetApi, AttachmentApi, ChecklistApi, CompanyApi, ConversationApi, GroupApi, LabelApi, RoomApi, SiteApi, UserApi, WorkOrderApi
```
public interface RemoteIdsApi
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Result<?>`	`addRemoteIds(String id, RemoteId... remoteIds)`	Add a remote id to the given entity.
`Result<?>`	`removeRemoteIds(String id, RemoteId... remoteIds)`	Remove a remote id from the given entity.
`Result<? extends Collection<? extends RemoteIdSearchResult>>`	`searchByRemoteId(String remoteIdType, String remoteId)`	Search for entities with remote ids for the current authenticated application.

- Method Detail
  - searchByRemoteId
```
Result<? extends Collection<? extends RemoteIdSearchResult>> searchByRemoteId(String remoteIdType,
                                                                              String remoteId)
```
    Search for entities with remote ids for the current authenticated application.
    
    Parameters:
    
    remoteIdType - Return all entities with the given type, regardless of value. If null, return all entities with a remote id.
    
    remoteId - Return all entities with the given id value. This parameter is ignored if `remoteIdType` is null.
  - addRemoteIds
```
Result<?> addRemoteIds(String id,
                       RemoteId... remoteIds)
```
    Add a remote id to the given entity. Remote id objects can be created using Worcade.createRemoteId(String, String)
  - removeRemoteIds
```
Result<?> removeRemoteIds(String id,
                          RemoteId... remoteIds)
```
    Remove a remote id from the given entity. Remote id objects can be created using Worcade.createRemoteId(String, String), or reused from Entity.getRemoteIds()