Sha256: 81d4249f698312fbe6b5337079093fd7f798dc57978164a3d9dc28a914b726ad
Contents?: true
Size: 1.67 KB
Versions: 4
Compression:
Stored size: 1.67 KB
Contents
# frozen_string_literal: true
module Dor
module Services
class Client
# API calls that are about starting accessioning on a repository object
class Accession < VersionedService
# @param connection [Faraday::Connection] an HTTP connection to dor-services-app
# @param version [String] id for the version of the API call
# @param object_identifier [String] the pid for the object
def initialize(connection:, version:, object_identifier:)
super(connection: connection, version: version)
@object_identifier = object_identifier
end
# Start accession on an object (start specified workflow, assemblyWF by default, and version if needed)
# @param params [Hash<Symbol,String>] optional parameter hash
# @option params [String] :description set description of version change - required
# @option params [String] :opening_user_name add opening username to the event - optional
# @option params [String] :workflow the workflow to start - defaults to 'assemblyWF'
# @return [Boolean] true on success
# @raise [NotFoundResponse] when the response is a 404 (object not found)
# @raise [UnexpectedResponse] when the response is not successful.
def start(params = {})
resp = connection.post do |req|
req.url with_querystring(url: path, params: params)
end
return true if resp.success?
raise_exception_based_on_response!(resp)
end
private
attr_reader :object_identifier
def path
"#{api_version}/objects/#{object_identifier}/accession"
end
end
end
end
end
Version data entries
4 entries across 4 versions & 1 rubygems