wsdl.Fedora-API-M-LITE.wsdl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fcrepo-client Show documentation
The Fedora Client is a Java Library that allows API access to a Fedora Repository. The client is typically one part of a full Fedora installation.
The newest version!



	
        
            
        
	

	
		
			a string value indicating the number of requested pid(s). Fedora will assume a default value of "1" if the numPids part is not specified.
		
		
			a string value indicating the namespace used for the requested pids. Fedora will assume the default value specified by
				the pidNamespace parameter in the fedora.fcfg configuration file if the "pidNamespace" part is not specified.
		
		
		a string value of "true" or "false" indicating that the repository should be XML encoded. Fedora will assume 
			a default of "false" if the "xml" part is not specified.
		
	
	
		
			The getNextPID response contains a list of the requested next available pids.
		
	

	
		  This is a simple URI-oriented service definition for the Management service 
			of a Fedora repository.  It is intended to support a REST-like style of access to the 
			Fedora Management web service (in contrast to a traditional SOAP web service definition).  
			This means that we define a simple URL syntax that can be used to issue service requests.
			API-M-LITE does not provide service bindings for all of the operations defined in Fedora's full
			Management service (API-M).  API-M-LITE currently only provides bindings for getNextPID. 
			The result of the getNextPID request is either HTML or XML, whichever the client requested. 
			 When URL syntax is shown below, green indicates required parts and red indicates optional parts.
		
		
			
				Gets a list of the requested next available pid(s). The PID list can be returned as XML data 
				or as an HTML presentation.
				URL Syntax:
				
					http://host:port/fedora/mgmt/getNextPID?{numPids=numPids&pidNamespace=pidNamespace&xml=boolean}
				
				 A complete example URL conforming to this syntax is:
				
					http://localhost:8080/fedora/mgmt/getNextPID?numPids=5&pidNamespace=my-pidNamespace&xml=true
				
			
			
			
		
	

	
		
		
			
			
				
				  This URL replacement syntax is used to request a description
					of the Fedora repository server.  The request will return key metadata elements
					about the repository server including repository name, version, baseURL,
					PID pidNamespace, and sample request URLs.  When putting together a proper URL, 
					the client should replace parenthesized parts of the operation location URL with actual values.  
					For example, "(boolean)" 	should be replaced with a "true" or "false" to indicate
					whether the repository information should be returned as XML (alternative is HTML).
					Parts of the operation location URL that are surrounded by brackets ("[ ]") are optional.  
					To construct a proper URL the client must replace the following variables with real information:
					      - numPids : an optional parameter. Client can specify the number of PIDs to request as a string
					        representing a positive integer. If omitted, the value defaults to "1".
					      - pidNamespace : an optional parameter. Client can specifiy the namespace of the requested PIDs
					        as a string. If omitted, the value defaults to the namespace defined in the fedora.fcfg file.
					 	- xml : an optional parameter.  Client can specify that the output of 
					 	  the operation be HTML or XML.   A value of "true" indicates a return type of 
					 	  text/xml; the absence of the xml parameter or a value of "false" indicates 
					 	  format is to be text/html.