image_add: Create new image

In mah0001/nadar: NADA API Client for R

Create new image

Description

Create a new image

Usage

image_add(
  idno,
  metadata,
  repositoryid = NULL,
  access_policy = NULL,
  data_remote_url = NULL,
  published = 0,
  overwrite = "no",
  thumbnail = NULL,
  api_key = NULL,
  api_base_url = NULL
)

Arguments

idno	(required) Unique identifier
metadata	(required) Metadata using the IPTC Image Schema
repositoryid	Owner Collection ID
access_policy	Select the access policy suitable for your data. Valid values - "open" "direct" "public" "licensed" "enclave" "remote" "other"
data_remote_url	Link to the website where the data is available. Required if access_policy is set to 'remote'.
published	Set status for study - 0 = Draft, 1 = Published
overwrite	Overwrite if a study with the same ID already exists? Valid values "yes", "no"

Examples

metadata=list(
   "repositoryid"= "central",
   "published"= "0",
   "overwrite"= "no",
   "metadata_information"= list(
     "title"= "string",
     "idno"= "string",
     "producers"= list(
       list(
         "name"= "string",
         "abbr"= "string",
         "affiliation"= "string",
         "role"= "string"
       )
       ),
     "production_date"= "string",
     "version"= "string"
   ),
   "image_description"= list(
     "iptc"= list(
       "mediafragment"= list(
         "uri"= "http://example.com",
         "delimitertype"= "spatial",
         "description"= "string"
       ),
       "photoVideoMetadataIPTC"= list(
         "aboutCvTerms"= list(
           list(
             "cvId"= "http://example.com",
             "cvTermName"= "string",
             "cvTermId"= "http://example.com",
             "cvTermRefinedAbout"= "http://example.com"
           )
           ),
         "additionalModelInfo"= "string",
         "artworkOrObjects"= list(
           list(
             "circaDateCreated"= "string",
             "contentDescription"= "string",
             "contributionDescription"= "string",
             "copyrightNotice"= "string",
             "creatorIdentifiers"= list(
               "string"
               ),
             "creatorNames"= list(
               "string"
               ),
             "currentCopyrightOwnerIdentifier"= "http://example.com",
             "currentCopyrightOwnerName"= "string",
             "currentLicensorIdentifier"= "http://example.com",
             "currentLicensorName"= "string",
             "dateCreated"= "2020-08-31T20:06:54Z",
             "physicalDescription"= "string",
             "source"= "string",
             "sourceInventoryNr"= "string",
             "sourceInventoryUrl"= "http://example.com",
             "stylePeriod"= list(
               "string"
               ),
             "title"= "string"
           )
           ),
         "captionWriter"= "string",
         "cityName"= "string",
         "copyrightNotice"= "string",
         "copyrightOwners"= list(
           list(
             "name"= "string",
             "role"= list(
               "http://example.com"
               ),
             "identifiers"= list(
               "http://example.com"
               )
           )
           ),
         "countryCode"= "string",
         "countryName"= "string",
         "creatorContactInfo"= list(
           "country"= "string",
           "emailwork"= "string",
           "region"= "string",
           "phonework"= "string",
           "weburlwork"= "string",
           "address"= "string",
           "city"= "string",
           "postalCode"= "string"
         ),
         "creatorNames"= list(
           "string"
           ),
         "creditLine"= "string",
         "dateCreated"= "2020-08-31T20:06:54Z",
         "description"= "string",
         "digitalImageGuid"= "string",
         "digitalSourceType"= "http://example.com",
         "embdEncRightsExpr"= list(
           list(
             "encRightsExpr"= "string",
             "rightsExprEncType"= "string",
             "rightsExprLangId"= "http://example.com"
           )
           ),
         "eventName"= "string",
         "genres"= list(
           list(
             "cvId"= "http://example.com",
             "cvTermName"= "string",
             "cvTermId"= "http://example.com",
             "cvTermRefinedAbout"= "http://example.com"
           )
           ),
         "headline"= "string",
         "imageRating"= 0,
         "imageSupplierImageId"= "string",
         "instructions"= "string",
         "intellectualGenre"= "string",
         "jobid"= "string",
         "jobtitle"= "string",
         "keywords"= list(
           "string"
           ),
         "linkedEncRightsExpr"= list(
           list(
             "linkedRightsExpr"= "http://example.com",
             "rightsExprEncType"= "string",
             "rightsExprLangId"= "http://example.com"
           )
           ),
         "locationsShown"= list(
           list(
             "city"= "string",
             "countryCode"= "string",
             "countryName"= "string",
             "gpsAltitude"= 0,
             "gpsLatitude"= 0,
             "gpsLongitude"= 0,
             "identifiers"= list(
               "http://example.com"
               ),
             "name"= "string",
             "provinceState"= "string",
             "sublocation"= "string",
             "worldRegion"= "string"
           )
           ),
         "maxAvailHeight"= 0,
         "maxAvailWidth"= 0,
         "minorModelAgeDisclosure"= "http://example.com",
         "modelAges"= list(
           0
           ),
         "modelReleaseDocuments"= list(
           "string"
           ),
         "modelReleaseStatus"= list(
           "cvId"= "http://example.com",
           "cvTermName"= "string",
           "cvTermId"= "http://example.com",
           "cvTermRefinedAbout"= "http://example.com"
         ),
         "organisationInImageCodes"= list(
           "string"
           ),
         "organisationInImageNames"= list(
           "string"
           ),
         "personInImageNames"= list(
           "string"
           ),
         "personsShown"= list(
           list(
             "name"= "string",
             "description"= "string",
             "identifiers"= list(
               "http://example.com"
               ),
             "characteristics"= list(
               list(
                 "cvId"= "http://example.com",
                 "cvTermName"= "string",
                 "cvTermId"= "http://example.com",
                 "cvTermRefinedAbout"= "http://example.com"
               )
               )
           )
           ),
         "productsShown"= list(
           list(
             "description"= "string",
             "gtin"= "string",
             "name"= "string"
           )
           ),
         "propertyReleaseDocuments"= list(
           "string"
           ),
         "propertyReleaseStatus"= list(
           "cvId"= "http://example.com",
           "cvTermName"= "string",
           "cvTermId"= "http://example.com",
           "cvTermRefinedAbout"= "http://example.com"
         ),
         "provinceStatePhoto"= "string",
         "registryEntries"= list(
           list(
             "role"= "http://example.com",
             "assetIdentifier"= "string",
             "registryIdentifier"= "http://example.com"
           )
           ),
         "sceneCodes"= list(
           "string"
           ),
         "source"= "string",
         "subjectCodes"= list(
           "string"
           ),
         "sublocationName"= "string",
         "supplier"= list(
           list(
             "name"= "string",
             "identifiers"= list(
               "http://example.com"
               )
           )
           ),
         "title"= "string",
         "usageTerms"= "string",
         "webstatementRights"= "http://example.com"
       )
     ),
     "license"= list(
       list(
         "name"= "string",
         "uri"= "string"
       )
       ),
     "album"= list(
       list(
         "name"= "string",
         "description"= "string",
         "owner"= "string",
         "uri"= "string"
       )
       ),
     "files"= list(
       list(
         "file_uri"= "string",
         "format"= "string",
         "note"= "string",
         "show"= true
       )
       )
   )
 )



 image_add (
  idno="image-idno",
  published = 1,
  overwrite = "yes",
  metadata = metadata,
  thumbnail ="path-to-thumbnail-file.jpg"
)

mah0001/nadar documentation built on March 30, 2024, 2:44 a.m.