Class ECpdsRESTV1

java.lang.Object
ecmwf.ecpds.master.plugin.service.ECpdsRESTV1
@Path("v1") public final class ECpdsRESTV1 extends Object
The Class ECpdsRESTV1.

  • Constructor Details

    • ECpdsRESTV1

      public ECpdsRESTV1()

  • Method Details

    • getVersion

      @GET @Produces("application/json") @Path("version") public jakarta.ws.rs.core.Response getVersion(@Context jakarta.servlet.http.HttpServletRequest request)
      Gets the version.
      Parameters:
      request - the request
      Returns:
      the version

    • incomingUserAdd

      @POST @Produces("application/json") @Path("incoming/user/add") public jakarta.ws.rs.core.Response incomingUserAdd(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("id") String id, @QueryParam("pass") String pass, @QueryParam("email") String email, @QueryParam("iso") String iso)
      Incoming user add.
      Parameters:
      authString - the auth string
      request - the request
      id - the id
      pass - the pass
      email - the email
      iso - the iso
      Returns:
      the response

    • incomingUserAdd2

      @POST @Produces("application/json") @Path("incoming/user/add2") public jakarta.ws.rs.core.Response incomingUserAdd2(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("id") String id, @QueryParam("email") String email, @QueryParam("iso") String iso)
      Incoming user add2.
      Parameters:
      authString - the auth string
      request - the request
      id - the id
      email - the email
      iso - the iso
      Returns:
      the response

    • incomingUserList

      @GET @Produces("application/json") @Path("incoming/user/list") public jakarta.ws.rs.core.Response incomingUserList(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("destination") String destination)
      Incoming user list.
      Parameters:
      authString - the auth string
      request - the request
      destination - the destination
      Returns:
      the response

    • userDel

      @DELETE @Produces("application/json") @Path("incoming/user/del/{id}") public jakarta.ws.rs.core.Response userDel(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @PathParam("id") String id)
      User del.
      Parameters:
      authString - the auth string
      request - the request
      id - the id
      Returns:
      the response

    • incomingCategoryAdd

      @POST @Consumes("application/json") @Produces("application/json") @Path("incoming/category/add") public jakarta.ws.rs.core.Response incomingCategoryAdd(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("id") String id, List<String> categories)
      Incoming category add.
      Parameters:
      authString - the auth string
      request - the request
      id - the id
      categories - the categories
      Returns:
      the response

    • incomingAssociationAdd

      @POST @Produces("application/json") @Path("incoming/association/add") public jakarta.ws.rs.core.Response incomingAssociationAdd(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("id") String id, @QueryParam("destination") String destination)
      Incoming association add.
      Parameters:
      authString - the auth string
      request - the request
      id - the id
      destination - the destination
      Returns:
      the response

    • incomingAssociationDel

      @DELETE @Produces("application/json") @Path("incoming/association/del") public jakarta.ws.rs.core.Response incomingAssociationDel(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("id") String id, @QueryParam("destination") String destination)
      Incoming association del.
      Parameters:
      authString - the auth string
      request - the request
      id - the id
      destination - the destination
      Returns:
      the response

    • incomingAssociationList

      @GET @Produces("application/json") @Path("incoming/association/list") public jakarta.ws.rs.core.Response incomingAssociationList(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("id") String id)
      Incoming association list.
      Parameters:
      authString - the auth string
      request - the request
      id - the id
      Returns:
      the response

    • destinationMetaFields

      @GET @Path("destination/metadata/fields") @Produces("application/json") public jakarta.ws.rs.core.Response destinationMetaFields(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request)
      GET /v1/destination/metadata/fields Returns all active metadata field definitions.
      Parameters:
      authString - the auth string
      request - the request
      Returns:
      the response

    • destinationMetadata

      @GET @Path("destination/{name}/metadata") @Produces("application/json") public jakarta.ws.rs.core.Response destinationMetadata(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @PathParam("name") String name)
      GET /v1/destination/{name}/metadata Returns all metadata values for a destination grouped by category, matching the structure of the UI JSON export. Each category contains field names mapped to their value(s); fields with no value are included as null. Multi-value fields are returned as arrays. Structured types (contact, mail-group, switchboard) are parsed from JSON to nested objects.
      Parameters:
      authString - the auth string
      request - the request
      name - the destination name
      Returns:
      the response

    • setDestinationMetadata

      @PUT @Path("destination/{name}/metadata") @Consumes("application/json") @Produces("application/json") public jakarta.ws.rs.core.Response setDestinationMetadata(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @PathParam("name") String name, Map<String,Object> body)
      PUT /v1/destination/{name}/metadata Replace all metadata values for a destination.

      Body (grouped format, matching the GET response): {"metadata":{"General":{"organisationWebPage":"..."},"Contacts":{"computerOperations":[{"name":"...","email":"..."}]}}} Field names are resolved to IDs via the DB field definitions. Null or missing fields are skipped (no value stored).

      Parameters:
      authString - the auth string
      request - the request
      name - the destination name
      body - the request body
      Returns:
      the response

    • destinationList

      @GET @Produces("application/json") @Path("destination/list") public jakarta.ws.rs.core.Response destinationList(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("iso") String iso, @QueryParam("id") String id, @QueryParam("type") Integer type)
      Destination list.
      Parameters:
      authString - the auth string
      request - the request
      iso - the iso
      id - the id
      type - the type
      Returns:
      the response

    • destination

      @GET @Produces("application/json") @Path("destination/{name}") public jakarta.ws.rs.core.Response destination(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @PathParam("name") String name)
      Destination.
      Parameters:
      authString - the auth string
      request - the request
      name - the name
      Returns:
      the response

    • getDestinationBackup

      @GET @Produces("application/json") @Path("destination/backup") public jakarta.ws.rs.core.Response getDestinationBackup(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("iso") String iso, @QueryParam("id") String id, @QueryParam("type") Integer type)
      Destination list.
      Parameters:
      authString - the auth string
      request - the request
      iso - the iso
      id - the id
      type - the type
      Returns:
      the response

    • getDestinationBackup

      @GET @Produces("application/json") @Path("destination/backup/{name}") public jakarta.ws.rs.core.Response getDestinationBackup(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @PathParam("name") String name)
      Destination.
      Parameters:
      authString - the auth string
      request - the request
      name - the name
      Returns:
      the response

    • putDestinationBackup

      @PUT @Consumes("application/json") @Produces("application/json") @Path("destination/backup") public jakarta.ws.rs.core.Response putDestinationBackup(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("copySharedHost") Boolean copySharedHost, ecmwf.ecpds.master.plugin.service.ECpdsRESTV1.PutDestinationBackupRequest backupRequest)
      Put destination backup.
      Parameters:
      authString - the auth string
      request - the request
      copySharedHost - the copy shared host
      backupRequest - the backup request
      Returns:
      the response

    • hostSetOption

      @POST @Consumes("application/x-www-form-urlencoded") @Produces("application/json") @Path("host/option") public jakarta.ws.rs.core.Response hostSetOption(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("hostid") String hostid, @QueryParam("name") String name, @FormParam("value") String value)
      Incoming association add.
      Parameters:
      authString - the auth string
      request - the request
      hostid - the hostid
      name - the name
      value - the value
      Returns:
      the response

    • destinationTypeList

      @GET @Produces("application/json") @Path("destination/type/list") public jakarta.ws.rs.core.Response destinationTypeList(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request)
      Destination type list.
      Parameters:
      authString - the auth string
      request - the request
      Returns:
      the response

    • destinationCountryList

      @GET @Produces("application/json") @Path("destination/country/list") public jakarta.ws.rs.core.Response destinationCountryList(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request)
      Destination country list.
      Parameters:
      authString - the auth string
      request - the request
      Returns:
      the response

    • stepStatusList

      @GET @Produces("application/json") @Path("monitoring/summary/{product}/{time}") public jakarta.ws.rs.core.Response stepStatusList(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @PathParam("product") String product, @PathParam("time") String time)
      Monitoring status list.
      Parameters:
      authString - the auth string
      request - the request
      product - the product
      time - the time
      Returns:
      the response

    • stepStatusHistoryList

      @GET @Produces("application/json") @Path("monitoring/summary/{product}/{time}/{step}/{type}") public jakarta.ws.rs.core.Response stepStatusHistoryList(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @PathParam("product") String product, @PathParam("time") String time, @PathParam("step") String step, @PathParam("type") String type)
      Monitoring status list.
      Parameters:
      authString - the auth string
      request - the request
      product - the product
      time - the time
      step - the step
      type - the type
      Returns:
      the response

    • datafilePut

      @GET @Produces("application/json") @Path("datafile/put") public jakarta.ws.rs.core.Response datafilePut(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("destination") String destination, @QueryParam("metadata") String metadata, @QueryParam("source") String source, @QueryParam("uniquename") String uniquename, @QueryParam("target") String target, @QueryParam("priority") Integer priority, @QueryParam("lifetime") String lifetime, @QueryParam("at") String at, @QueryParam("standby") Boolean standby, @QueryParam("force") Boolean force)
      Datafile put.
      Parameters:
      authString - the auth string
      request - the request
      destination - the destination
      metadata - the metadata
      source - the source
      uniquename - the uniquename
      target - the target
      priority - the priority
      lifetime - the lifetime
      at - the at
      standby - the standby
      force - the force
      Returns:
      the response

    • datafileSize

      @GET @Produces("application/json") @Path("datafile/size") public jakarta.ws.rs.core.Response datafileSize(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("id") Long id)
      Datafile size.
      Parameters:
      authString - the auth string
      request - the request
      id - the id
      Returns:
      the response

    • datafileDel

      @DELETE @Produces("application/json") @Path("datafile/del") public jakarta.ws.rs.core.Response datafileDel(@HeaderParam("authorization") String authString, @Context jakarta.servlet.http.HttpServletRequest request, @QueryParam("id") Long id)
      Datafile del.
      Parameters:
      authString - the auth string
      request - the request
      id - the id
      Returns:
      the response