mpg_pure.ItemsPublicationsApi

All URIs are relative to https://pure.mpg.de/rest

Method	HTTP request	Description
create_using_post1	POST /items	create
delete_using_delete1	DELETE /items/{itemId}	delete
get_component_content_using_get	GET /items/{itemId}/component/{componentId}/content	getComponentContent
get_technical_metadata_by_tika_using_get	GET /items/{itemId}/component/{componentId}/metadata	getTechnicalMetadataByTika
get_using_get1	GET /items/{itemId}	get
get_version_history_using_get	GET /items/{itemId}/history	getVersionHistory
release_using_put	PUT /items/{itemId}/release	release
revise_using_put	PUT /items/{itemId}/revise	revise
search_scroll_using_get	GET /items/search/scroll	searchScroll
search_using_post	POST /items/search	search
submit_using_put	PUT /items/{itemId}/submit	submit
update_using_put1	PUT /items/{itemId}	update
withdraw_using_put	PUT /items/{itemId}/withdraw	withdraw

create_using_post1

ItemVersionVO create_using_post1(authorization, item)

create

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
authorization = 'authorization_example' # str | Authorization
item = mpg_pure.ItemVersionVO() # ItemVersionVO | item

try:
    # create
    api_response = api_instance.create_using_post1(authorization, item)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->create_using_post1: %s\n" % e)

Parameters

Name	Type	Description	Notes
authorization	str	Authorization
item	ItemVersionVO	item

Return type

ItemVersionVO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_using_delete1

object delete_using_delete1(authorization, item_id, params)

delete

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
authorization = 'authorization_example' # str | Authorization
item_id = 'item_id_example' # str | itemId
params = mpg_pure.TaskParamVO() # TaskParamVO | params

try:
    # delete
    api_response = api_instance.delete_using_delete1(authorization, item_id, params)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->delete_using_delete1: %s\n" % e)

Parameters

Name	Type	Description
authorization	str	Authorization
item_id	str	itemId
params	TaskParamVO	params

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_component_content_using_get

get_component_content_using_get(component_id, item_id, authorization=authorization, download=download)

getComponentContent

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
component_id = 'component_id_example' # str | componentId
item_id = 'item_id_example' # str | itemId
authorization = 'authorization_example' # str | Authorization (optional)
download = false # bool | download (optional) (default to false)

try:
    # getComponentContent
    api_instance.get_component_content_using_get(component_id, item_id, authorization=authorization, download=download)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->get_component_content_using_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
component_id	str	componentId
item_id	str	itemId
authorization	str	Authorization	[optional]
download	bool	download	[optional] [default to false]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_technical_metadata_by_tika_using_get

str get_technical_metadata_by_tika_using_get(component_id, item_id, authorization=authorization)

getTechnicalMetadataByTika

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
component_id = 'component_id_example' # str | componentId
item_id = 'item_id_example' # str | itemId
authorization = 'authorization_example' # str | Authorization (optional)

try:
    # getTechnicalMetadataByTika
    api_response = api_instance.get_technical_metadata_by_tika_using_get(component_id, item_id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->get_technical_metadata_by_tika_using_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
component_id	str	componentId
item_id	str	itemId
authorization	str	Authorization	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_using_get1

ItemVersionVO get_using_get1(item_id, authorization=authorization)

get

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
item_id = 'item_id_example' # str | itemId
authorization = 'authorization_example' # str | Authorization (optional)

try:
    # get
    api_response = api_instance.get_using_get1(item_id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->get_using_get1: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	itemId
authorization	str	Authorization	[optional]

Return type

ItemVersionVO

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_version_history_using_get

list[AuditDbVO] get_version_history_using_get(authorization, item_id)

getVersionHistory

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
authorization = 'authorization_example' # str | Authorization
item_id = 'item_id_example' # str | itemId

try:
    # getVersionHistory
    api_response = api_instance.get_version_history_using_get(authorization, item_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->get_version_history_using_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
authorization	str	Authorization
item_id	str	itemId

Return type

list[AuditDbVO]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

release_using_put

ItemVersionVO release_using_put(authorization, item_id, params)

release

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
authorization = 'authorization_example' # str | Authorization
item_id = 'item_id_example' # str | itemId
params = mpg_pure.TaskParamVO() # TaskParamVO | params

try:
    # release
    api_response = api_instance.release_using_put(authorization, item_id, params)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->release_using_put: %s\n" % e)

Parameters

Name	Type	Description
authorization	str	Authorization
item_id	str	itemId
params	TaskParamVO	params

Return type

ItemVersionVO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revise_using_put

ItemVersionVO revise_using_put(authorization, item_id, params)

revise

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
authorization = 'authorization_example' # str | Authorization
item_id = 'item_id_example' # str | itemId
params = mpg_pure.TaskParamVO() # TaskParamVO | params

try:
    # revise
    api_response = api_instance.revise_using_put(authorization, item_id, params)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->revise_using_put: %s\n" % e)

Parameters

Name	Type	Description
authorization	str	Authorization
item_id	str	itemId
params	TaskParamVO	params

Return type

ItemVersionVO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_scroll_using_get

SearchRetrieveResponseVOItemVersionVO search_scroll_using_get(scroll_id, authorization=authorization, citation=citation, csl_cone_id=csl_cone_id, format=format)

searchScroll

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
scroll_id = 'scroll_id_example' # str | scrollId
authorization = 'authorization_example' # str | Authorization (optional)
citation = 'citation_example' # str | citation (optional)
csl_cone_id = 'csl_cone_id_example' # str | cslConeId (optional)
format = 'format_example' # str | format (optional)

try:
    # searchScroll
    api_response = api_instance.search_scroll_using_get(scroll_id, authorization=authorization, citation=citation, csl_cone_id=csl_cone_id, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->search_scroll_using_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
scroll_id	str	scrollId
authorization	str	Authorization	[optional]
citation	str	citation	[optional]
csl_cone_id	str	cslConeId	[optional]
format	str	format	[optional]

Return type

SearchRetrieveResponseVOItemVersionVO

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_using_post

SearchRetrieveResponseVOItemVersionVO search_using_post(query, authorization=authorization, citation=citation, csl_cone_id=csl_cone_id, format=format, scroll=scroll)

search

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
query = mpg_pure.JsonNode() # JsonNode | query
authorization = 'authorization_example' # str | Authorization (optional)
citation = 'APA' # str | citation (optional) (default to APA)
csl_cone_id = 'csl_cone_id_example' # str | cslConeId (optional)
format = 'json' # str | format (optional) (default to json)
scroll = true # bool | scroll (optional)

try:
    # search
    api_response = api_instance.search_using_post(query, authorization=authorization, citation=citation, csl_cone_id=csl_cone_id, format=format, scroll=scroll)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->search_using_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	JsonNode	query
authorization	str	Authorization	[optional]
citation	str	citation	[optional] [default to APA]
csl_cone_id	str	cslConeId	[optional]
format	str	format	[optional] [default to json]
scroll	bool	scroll	[optional]

Return type

SearchRetrieveResponseVOItemVersionVO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submit_using_put

ItemVersionVO submit_using_put(authorization, item_id, params)

submit

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
authorization = 'authorization_example' # str | Authorization
item_id = 'item_id_example' # str | itemId
params = mpg_pure.TaskParamVO() # TaskParamVO | params

try:
    # submit
    api_response = api_instance.submit_using_put(authorization, item_id, params)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->submit_using_put: %s\n" % e)

Parameters

Name	Type	Description
authorization	str	Authorization
item_id	str	itemId
params	TaskParamVO	params

Return type

ItemVersionVO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_using_put1

ItemVersionVO update_using_put1(authorization, item, item_id)

update

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
authorization = 'authorization_example' # str | Authorization
item = mpg_pure.ItemVersionVO() # ItemVersionVO | item
item_id = 'item_id_example' # str | itemId

try:
    # update
    api_response = api_instance.update_using_put1(authorization, item, item_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->update_using_put1: %s\n" % e)

Parameters

Name	Type	Description
authorization	str	Authorization
item	ItemVersionVO	item
item_id	str	itemId

Return type

ItemVersionVO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

withdraw_using_put

ItemVersionVO withdraw_using_put(authorization, item_id, params)

withdraw

Example

from __future__ import print_function
import time
import mpg_pure
from mpg_pure.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = mpg_pure.ItemsPublicationsApi()
authorization = 'authorization_example' # str | Authorization
item_id = 'item_id_example' # str | itemId
params = mpg_pure.TaskParamVO() # TaskParamVO | params

try:
    # withdraw
    api_response = api_instance.withdraw_using_put(authorization, item_id, params)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemsPublicationsApi->withdraw_using_put: %s\n" % e)

Parameters

Name	Type	Description
authorization	str	Authorization
item_id	str	itemId
params	TaskParamVO	params

Return type

ItemVersionVO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ItemsPublicationsApi.md

Latest commit

History

ItemsPublicationsApi.md

File metadata and controls

mpg_pure.ItemsPublicationsApi

create_using_post1

Example

Parameters

Return type

Authorization

HTTP request headers

delete_using_delete1

Example

Parameters

Return type

Authorization

HTTP request headers

get_component_content_using_get

Example

Parameters

Return type

Authorization

HTTP request headers

get_technical_metadata_by_tika_using_get

Example

Parameters

Return type

Authorization

HTTP request headers

get_using_get1

Example

Parameters

Return type

Authorization

HTTP request headers

get_version_history_using_get

Example

Parameters

Return type

Authorization

HTTP request headers

release_using_put

Example

Parameters

Return type

Authorization

HTTP request headers

revise_using_put

Example

Parameters

Return type

Authorization

HTTP request headers

search_scroll_using_get

Example

Parameters

Return type

Authorization

HTTP request headers

search_using_post

Example

Parameters

Return type

Authorization

HTTP request headers

submit_using_put

Example

Parameters

Return type

Authorization

HTTP request headers

update_using_put1

Example

Parameters

Return type

Authorization

HTTP request headers

withdraw_using_put