Archive 2.x:CRUD: Create/2
The CRUD: Create Web service is used to create a new instance record in a target dataset registered to a WSF (Web Services Framework). When a new instance record is created, it becomes accessible to the users that have access to this dataset.
Developers communicate with the CRUD: Create Web service using the HTTP POST method. You may request any content type (*/*).
This documentation page is used for the version 2 of this endpoint. Check at the top of this page to see the documentation pages for the other versions of this endpoint.
This Web service is intended to be used by any user that wants to create some information instance records in a dataset registered to a WSF (Web Service Framework) for querying or other purposes.
If you are creating an already created record, no error will be reported by the web service endpoint. However, this behavior has to be keep in mind: for the triple store, all the triples will be added, but no triples will be deleted; for the Solr index, the record Solr documents will be replaced by the input record to create. This means that the behavior of the triple store and the Solr index behave differently if the record is already existing.
Read the usage section of the CRUD: Update web service endpoint for more detailed information about the difference between the CRUD Create and CRUD Update web service endpoints.
Here are a few things you can configure to change the behavior of a CRUD: Create web service endpoint.
You can geo-enable the CRUD: Create web service endpoint. By geo-enabling the service, you will change the behavior of the endpoint such that if it detects that a record that is being indexed has geo-related information, then it will properly index that information such that other geo-enabled services, such as the Search web service endpoint, can leverage that information to perform different geo-related tasks.
Also read that other zWiki page that tells you how to geo-enabled a record description: Geo-enabling Datasets
To geo-enable a CRUD: Create web service endpoint you have to make sure that:
- The Solr instance is using the the Solr Spatial Query fix, and read this introduction article for good background information about this topic: Location-aware search with Apache Lucene and Solr
- The Solr instance is using the
- The network.ini configuration file specify that the OSF Web Service instance is geo-enabled by specifying
geoenabled = truein the
Web Service Endpoint Information
This section describes all you permissions you need in the WSF (Web Service Framework) to send a query to this Web service endpoint, and it describes how to access it.
To access this Web service endpoint you need the proper CRUD (Create, Read, Update and Delete) permissions on a specific graph (dataset) of the WSF. Without the proper permissions on this graph you won't be able to send any queries to the endpoint.
- Create: True
- Read: False
- Update: False
- Delete: False
As shown on the graph URI:
- Target dataset URI
Here is the information needed to communicate with this Web service's endpoint. Descriptions of the parameters are included below.
Note: if a parameter has a default value, the requester can omit it and the default value will be used. Also, some baseline Web services may not offer other values than the default.
Possible "Accept:" HTTP header field value:
- http://[...]/ws/crud/create/ ?document=param1&mime=param2&mode=param3&dataset=param4®istered_ip=param5&interface=param6
URI dynamic parameters description:
Note: All parameters have to be URL-encoded
- param1. RDF document where instance record(s) are described. The size of this document is limited to 8MB
- param2. One of:
- application/rdf+xml — RDF document serialized in XML
- application/rdf+n3 — RDF document serialized in N3
- param3. One of:
- full (default) — Index in both the triple store (Virtuoso) and search index
- triplestore — Index in the triple store (Virtuoso) only
- searchindex — Index in the search index (Solr) only
- param4. Dataset URI where to index the RDF document
- param5. Target IP address registered in the WSF
- param6. Source interface used for this web service query. The interface is a different way to process a query (different algorithms, different data management system, etc. The default interface is 'default'
Available Sources Interfaces
A source interface is a way to process a web service query. Different sources interfaces can be implemented for the same OSF Web Service endpoint. Each interface will process the query differently, but all the queries to the web service endpoint will be the same, at the exception of the
interface parameter. Each interface shares the same API (the one defined by the web service endpoint), but their processing may differ (like using different algorithms, using different data management systems, etc.)
This is a list of the core interfaces for this endpoint. Organizations that hosts a OSF Web Service network could create their own interface and make it available to the users. However such private source interface won't be part of this list, but should be publicized by the organization.
|Source Interface Name||Description|
||Default source interface for this OSF Web Service endpoint. This interface implements the default behavior of this OSF Web Service endpoint.|
Query Answer from the Endpoint
If the query is successfully performed by the endpoint (i.e., the Web service resource has been properly created, updated or deleted), the endpoint will return the HTTP status message "200 OK" with an empty body. If an error occurred, one of the HTTP status messages with the description of the error message in the body of the HTTP query will be returned.
HTTP Status Codes
Here are the possible HTTP status (error) codes returned by this Web service endpoint.
On error code and the specific error, a different message description can be issued (meaning a different error has been returned).
- Code: 200
- Message: OK
- Code: 400
- Message: Bad Request
- Message description: No RDF document to index
- Message description: No dataset specified
- Message description: Unknown MIME type for this RDF document (XYZ)
- Message description: Error #crud-create-100. Syntax error in the RDF document: XYZ
- Message description: No unique identifier specified for this dataset
- Message description: No target dataset
- Message description: No Web service URI available
- Message description: Target Web service XYZ not registered to this Web Services Framework
- Message description: No access defined for this requester IP XYZ, dataset (XYZ) and Web service (XYZ)
- Message description: The target Web service (XYZ) needs create access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
- Message description: The target Web service (XYZ) needs read access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
- Message description: The target Web service (XYZ) needs update access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
- Message description: The target Web service (XYZ) needs delete access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
- Code: 406
- Message: Not Acceptable
- Message description: Unacceptable mime type requested
- Code: 500
- Message: Internal Error