Funciones de la API del servidor CONTENTdm - dmwebservices

http://yourCONTENTdmURL/digital/bl/dmwebservices/index.php?
q=dmGetDublinCoreFieldInfo/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• El formato es xml o json

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?
q=dmGetDublinCoreFieldInfo/xml

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetLocale/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• formato es xml o json

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetLocale/xml

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetStopWords/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• formato es xml o json

Stopwords.txt es un archivo global para el servidor, por lo que no se requiere ningún alias de colección.

Una lista de las palabras de parada enumeradas en Stopwords.txt.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetStopWords/json

Devuelve una matriz de términos para el campo especificado por el alias de colección y el apodo de campo dados.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetCollectionFieldVocabulary/ctimes/subjec/0/1/xml

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetCollectionWords/mycollection/title!subjec/xml

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmEADSearchTotals/alias/searchterm^mode/id/pagecount/document_type/find/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• searchterm^mode donde searchterm es el término buscado y mode es el tipo de búsqueda. el modo puede ser "cualquiera", "todos" o "exacto".
• id es el identificador del objeto
• pagecount es el número de páginas en el objeto compuesto
• document_type es guía de búsqueda
• find es el nombre de archivo de la propiedad find de dmGetItemInfo
• Formato es XML o JSON

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmEADSearchTotals/mycollection/bridge^any/8/2/findingaid/9.cpd/json

devuelve:

{"pager":{"inicio":1,"maxrecs":10,"total":10},"registros":[["6",39],["7",4]]}

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmFullTextTotals/alias/field^searchterm^mode/return_field/id/pagecount/document_type/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• campo^searchterm^mode donde campo es el campo de búsqueda de texto completo; searchterm es el término buscado; y mode es el tipo de búsqueda. el modo puede ser "cualquiera", "todos" o "exacto".
• return_field es el campo devuelto de la búsqueda. Para esta función, esto es lo mismo que el campo de texto completo buscado
• id es el identificador del objeto
• pagecount es el número de páginas en el objeto compuesto
• document_type es un tipo de documento ("compobj")
• find es el nombre de archivo de la propiedad find de dmGetItemInfo
• Formato es XML o JSON

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmFullTextTotals/mycollection/transc^bridge^any/transc/102/6/compobj/json

Devoluciones

{"pager":{"start":0,"maxrecs":"6","total":3},"records":[[96,1],[98,5],[99,4]]}

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?
q=dmGetImageInfo/alias/pointer/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• puntero es el puntero al documento cuya información de imagen desea obtener
• El formato es xml o json

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?
q=dmGetImageInfo/pgpl/525/xml

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?
q=dmGetItemInfo/alias/pointer/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• puntero es el puntero al documento para el cual usted desea metadatos
• El formato es xml o json

Esta función devuelve los metadatos descriptivos y administrativos de un documento. Los elementos de los metadatos descriptivos se determinan por la configuración de los campos de la colección, y los metadatos administrativos se agregan automáticamente por CONTENTdm. Los campos vacíos están presentes en XML como elementos vacíos y en JSON como arreglos vacíos. Si no se encuentra el documento, la función devuelve el siguiente mensaje de error:

-2 Documento solicitado no encontrado

Esta función también realiza llamadas directas a dmItemHasOCRText y dmItemFileSize para eliminar la necesidad de llamadas API adicionales.

http://tuURLdeCONTENTdm.com/digital/bl/dmwebservices/index.php?
q=dmGetItemInfo/uw/31/json

devuelve:

{
"title": "Prince George Citizen, miércoles, 17 de mayo de 1916",
"date": "17/05/1916;",
"rights": "Dominio público",
"format": "Texto",
"type": "Imagen\/jpeg",
"langua": "eng",
"full": {

},
"fullrs": {

},
"find": "526.cpd",
"dmaccess": {

},
"dmimage": {

},
"dmcreated": "22-09-2009",
"dmmodified": "22-09-2009",
"dmoclcno": {

},
"dmrecord": "525",
"cdmfilesize": "216 777",
"cdmfilesizeformatted": "0,21" MB",
"cdmhasocr":"1"
}

La versión XML de este registro es:

17-05-1916;
Dominio público
Texto
Imagen/jpeg
eng


526.cpd


22-09-2009
22-09-2009

525
216 777
0,21 MB
1

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetItemUrl/alias/find/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• find es el nombre de archivo de la propiedad find de dmGetItemInfo
• Formato es JSON

Esta función recupera la URL de un documento URL.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetItemUrl/mycollection/1.url/json

devuelve:

{"URL":"http://www.myurl.com"}

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetRecent/alias/num/fields/mode/imagesonly/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• num es el número de documentos a devolver
• Campos es una lista delimitada por ! de nombres abreviados de campos que enumera los campos para los que se deben devolver metadatos. Se puede especificar un máximo de cinco campos. Se devuelve un máximo de 100 bytes por cada campo.
• modo es el tipo de consulta que se ejecutará para devolver el conjunto de documentos más reciente, más antiguo o aleatorio. 0=más reciente (por defecto), 1=el más antiguo, 2=aleatorio
• imagesonly se puede establecer en "1" o "0": 1=solo imágenes (predeterminado), 0=todos los documentos
• El formato puede ser XML o JSON

Una lista de registros producidos por la consulta, además del total de registros devueltos.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetRecent/mycollection/5/title/0/1/xml

devuelve:

< xml versión="1.0" encoding="UTF-8"?>
< results>
< total>5 < records>
< record>
< collection> < pointer> < title> < date> < /record>
< record>
< collection> < pointer> < title> < date> < /record>
< record>
< collection> < pointer> < title> < colección> < título>
< record>
< collection> < pointer> < title> < date> < /record>
< record>
< collection> < pointer> < title> < date> < record>
< /records>
< colección> < título> < colección> < título> < colección> < título> < colección> < título>

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetStreamingFile/alias/find/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• find es el nombre de archivo de la propiedad find de dmGetItemInfo
• El formato es xml o json

Esta función obtendrá el archivo local y lo entregará como un recurso de transmisión para su reproducción o descarga.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmGetStreamingFile/mycollection/1.mp4/xml

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmItemFileSize/alias/pointer/extension/sizeunit/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• puntero es el identificador del documento para el cual se recuperará el tamaño
• extensión es la extensión de archivo del documento
• sizeunit es un número entero que indica las unidades de la cadena formateada devuelta: 0 para bytes, 1 para KB, 2 para MB, 3 para GB
• El formato puede ser xml, json o función. Cuando se llama al método directamente a través de la URL, se debe utilizar XML o JSON. Al llamar al método desde otra función dentro de la API (como se hace en dmGetItemInfo), debe utilizarse la función.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmItemFileSize/mycollection/7/pdf/2/json

devuelve:

Array([tamaño] => 16 831 177 [formateado] => 16,05 MB)

Esta función también se invoca directamente desde dmGetItemInfo para evitar la necesidad de llamadas adicionales a la API.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmItemHasOCRText/alias/pointer/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• elpuntero es la ID del material para comprobar el texto OCR
• El formato puede ser xml, json o función. Cuando se llama al método directamente a través de la URL, se debe utilizar XML o JSON. Al llamar al método desde otra función dentro de la API (como se hace en dmGetItemInfo), debe utilizarse la función.

Una matriz con un solo documento, hasOCR, con un valor de 1 (tiene texto OCR) o 0 (sin texto OCR).

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmItemHasOCRText/mycollection/7/json

devuelve:

Array([hasOCR] => 1)

Esta función también se invoca directamente desde dmGetItemInfo para evitar la necesidad de llamadas adicionales a la API.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmQuery/alias/searchstrings/fields/sortby/
maxrecs/start/suppress/docptr/suggest/facets/showunpub/denormalizeFacets/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• Si se utiliza dmQuery con múltiples colecciones, los parámetros de consulta deben seguir las reglas de mapeo de Dublin Core y utilizar los nombres del campo de mapeo de Dublin Core en Propiedades de campo.
• alias es un único alias de colección, una lista de alias de colección delimitada por !, o "all" para todas las colecciones.
• searchstrings es un grupo de cuatro partes, delimitado por ^ en el orden campo^cadena^modo^operador.
  • Utilice "CISOSEARCHALL" para todos los campos; el modo puede ser "todo", "cualquiera", "exacto" o "ninguno"; el operador puede ser "y" o "o".
  • Varias palabras en la cadena deben separarse por "+".
  • Se pueden incluir hasta seis grupos, delimitados por "!".
  • Para explorar una colección, especifique un solo alias y "0" como valor de las cadenas de búsqueda. Se ignorará el operador de la última cadena de búsqueda.
• Campos es una lista delimitada por "!" de apodos de campo, que enumera los campos para los cuales se deben devolver metadatos. 
  • Se puede especificar un máximo de cinco campos. Se devuelve un máximo de 100 bytes por cada campo.
• sortby es una lista delimitada por ! de apodos de campo, que detalla cómo debe ordenarse el resultado, en el orden de los campos.
  • Los apodos de los campos deben aparecer en el arreglo de campos. Si el último elemento del arreglo se especifica como "reverse".
    • El ordenamiento será en orden inverso (descendente). Utilice "nosort" para ordenar la consulta por relevancia.
• maxrecs es el número máximo de registros que se devolverán, de 1 a 1024.
• inicio es el número inicial del primer elemento devuelto en el resultado.
• suprimir especifica si se deben suprimir las páginas de objetos compuestos de la búsqueda. Utilice "1" para suprimir o "0" para no suprimir (es decir, incluir las páginas).
• docptr especifica el valor del puntero de un objeto compuesto para restringir la consulta únicamente a las páginas de dicho objeto compuesto. Esto requiere que usted especifique un solo alias. Si no se especifica, utilice "0".
• sugerir especifica si se devolverá una sugerencia ortográfica, si está disponible para la cadena de búsqueda. Utilice "1" para obtener sugerencias o utilice "0" para no devolver ninguna sugerencia.
• facets es una lista opcional delimitada por '!' de apodos de campo que se devolverán como facetas. Utilice "0" si no solicita facetas.
• showunpub especifica si se deben mostrar o no los documentos de colecciones no publicadas. Utilice «1» si solicita documentos de colecciones no publicadas o «0» para ocultar documentos de colecciones no publicadas.
• denormalizeFacets especifica si se mostrarán mayúsculas y diacríticos en los campos de facetas que comparten un Vocabulario Controlado.  Use "1" si solicita el uso de mayúsculas y diacríticos o "0" para desactivar el uso de mayúsculas y diacríticos.
• El formato es "xml" o "json".

Esta función devuelve una lista de registros producidos por la consulta, además de un paginador que contiene valores para inicio, máximo de registros y total.

Si se incluyen facetas, esta función devuelve una lista de facetas en el(los) campo(s) indicado(s).

Si la sugerencia es "1", se devuelve la ortografía sugerida.

Si showunpub es "1", se incluirán los registros de colecciones no publicadas.

Si denormalizeFacets es «1» y facets no es «0», sino una lista delimitada por ! de apodos de campos, entonces los campos de faceta solicitados se mostrarán con mayúsculas y diacríticos.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmQueryTotalRecs/queries/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• Las consultas están delimitadas por ~ y las partes de cada consulta están delimitadas por |. Las partes de cada consulta son: alias|searchstring|return_fields|ordenar. Consulte dmQuery para más información detallada.
• Formato es XML

El número total de registros para cada consulta.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?q=dmQueryTotalRecs/mycollection|subject^word^all^and|subjec!title|nosort~
mycollection|title^contentdm^all^and|subjec!title|nosort/xml

Para cada consulta en las consultas, esta función ejecuta una consulta con un límite máximo de un registro devuelto. Luego extrae el total de registros de la consulta de la información de paginación en los datos devueltos.

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?
q=GetItemDmmodified/alias/pointer/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• puntero es el puntero del documento cuya fecha de última modificación desea
• Formato es JSON

Esta función no forma parte de la API estándar de CONTENTdm. Es un subconjunto de dmGetItemInfo, diseñado para una recuperación eficiente en tiempo real de la fecha de la última modificación de un documento, de modo que se pueda emitir una solicitud completa a dmGetItemInfo si es necesario.

El valor del elemento dmmodified para el documento solicitado. Si no se encuentra el documento, se devuelve el siguiente mensaje de error:

-2
El documento solicitado no fue encontrado

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?
q=GetItemDmmodified/uw/31/json

devuelve:

{"0":"22-09-2009"}

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?
q=GetParent/alias/pointer/format

• Sustituya yourCONTENTdmURL por la URL del sitio web de CONTENTdm de su institución.
• alias es un alias de una colección
• puntero es el puntero del elemento cuyo padre desea obtener
• El formato es xml o json

http://yourCONTENTdmURL.com/digital/bl/dmwebservices/index.php?
q=GetParent/ukr/83062/xml

devuelve:

< parent>83090</parent>