org.jbei.ice.services.rest

Class CustomFieldResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

org.jbei.ice.services.rest.CustomFieldResource

@Path(value="/custom-fields")
public class CustomFieldResource
extends RestResource

REST API for ICE custom fields (typically) associated with parts

Author:

Hector Plahar

Field Summary

Fields inherited from class org.jbei.ice.services.rest.RestResource

API_KEY_CLIENT_ID, API_KEY_TOKEN, API_KEY_USER, apiClientId, apiToken, apiUser, AUTHENTICATION_PARAM_NAME, hmacHeader, querySessionId, REMOTE_USER_ID, REMOTE_USER_TOKEN, remoteUserId, remoteUserToken, request, sessionId, WOR_PARTNER_TOKEN, worPartnerToken

Constructor Summary

Constructors

Constructor and Description
CustomFieldResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(long partId, CustomField customField) Creates a new custom field and associated it with the specified entry.
javax.ws.rs.core.Response	delete(long id)
javax.ws.rs.core.Response	get(long id)
javax.ws.rs.core.Response	getPartByCustomFields(javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	list(long partId)
javax.ws.rs.core.Response	update(long id, CustomField customField)

Methods inherited from class org.jbei.ice.services.rest.RestResource

addHeaders, getThisServer, getUserId, getUserId, getWebPartner, log, requireUserId, requireUserIdOrWebPartner, requireWebPartner, respond, respond, respond, respond

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomFieldResource

public CustomFieldResource()

Method Detail

getPartByCustomFields

@GET
 @Path(value="/parts")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getPartByCustomFields(@Context
                                                                                                                                                             javax.ws.rs.core.UriInfo uriInfo)

create

@POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response create(@QueryParam(value="partId")
                                                                                                                        long partId,
                                                                                                                        CustomField customField)

Creates a new custom field and associated it with the specified entry. There are two ways to specify the entry to associate the field with:

1. In the custom field object.
2. Using the query parameter partId

If both are set, they must have the same value

Parameters:

partId - optional (as long as value is set in the custom field object) entry part identifier

customField - data for custom fields

get

@GET
 @Path(value="/{id}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response get(@PathParam(value="id")
                                                                                                     long id)

list

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response list(@QueryParam(value="partId")
                                                                                long partId)

update

@PUT
 @Path(value="/{id}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response update(@PathParam(value="id")
                                                                                                                                             long id,
                                                                                                                                             CustomField customField)

delete

@DELETE
 @Path(value="/{id}")
public javax.ws.rs.core.Response delete(@PathParam(value="id")
                                                                      long id)