Skip to content

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
    • Help
    • Support
    • Submit feedback
    • Contribute to GitLab
  • Sign in
N
nesstar-rest-api
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 1
    • Issues 1
    • List
    • Boards
    • Labels
    • Milestones
  • Merge Requests 0
    • Merge Requests 0
  • Analytics
    • Analytics
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
  • Nesstar
  • nesstar-rest-api
  • Wiki
  • get study metadata

get study metadata

Last edited by Eirik Alvær Oct 31, 2013
Page history

Get study metadata

Request

This method returns study metadata using a predefined structure.

{
   url: "/study/{studyId}"
}

Response

An object of the same structure as described below. Empty fields will be removed from the result.

{"payload":{
   "ID":"./@ID",
   "version":"1.2.2",
   "fileDscr":{
      "fileTxt":{
         "fileName":"text",
         "fileType":"text",
            "dimensns":{
               "caseQnty":"number",
               "varQnty":"number"
            }
         }
      }
   },
   "docDscr":{
      "citation":{
         "titlStmt":{
            "titl":"text",
            "parTitl":"text"
         },
         "rspStmt":{
            "AuthEnty":"text"
         },
         "prodStmt":{
            "copyright":"text",
            "producer":"text",
            "prodDate":"text"
         }
      }
   },
   "stdyDscr":{
      "citation":{
         "titlStmt":{
            "titl":"text",
            "IDNo":"text"
         },
         "rspStmt":{
            "AuthEnty":"text",
            "othId":"text"
         },
         "prodStmt":{
            "copyright":"text",
            "prodDate":"date",
            "producer":{
               "affiliation":"text",
               "content":"text"
            }
         },
         "serStmt":{
            "serName":"text"
         },
         "verStmt":{
            "version":{
               "date":"date"
            }
         },
         "biblCit":"date",
         "distStmt":{
            "distrbtr":"text",
            "distDate":{
               "date":"date"
            }
         }
      },
      "stdyInfo":{
         "subject":{
            "keyword":"text",
            "topcClas":".text"
         },
         "abstract":"text",
         "sumDscr":{
            "collDate":[
               {
                  "event":"start",
                  "content":"date"
               },
               {
                  "event":"end",
                  "content":"date"
               }
            ],
            "nation":"text",
            "geogCover":"text",
            "geogUnit":"text",
            "anlyUnit":"text",
            "universe":"text",
            "dataKind":"text"
         }
      },
      "method":{
         "dataColl":{
            "dataCollector":"text",
            "dataSrc":"text",
            "weight":"text",
            "sampProc":"text",
            "collMode":"text",
            "timeMeth":"text"
         }
      },
      "dataAccs":{
         "useStmt" : {
            "restrctn":"text"
         },
         "setAvail":{
            "accsPlac":"text"
         }
      }
   }
}
}
Clone repository
  • Login
  • Logout
  • do correlation
  • do regression
  • download
  • errors
  • get complete study metadata
  • get cube
  • get ddi metadata translation
  • get study list
  • get study metadata
  • get study variablegroups
  • get study variables
  • get variable metadata
  • get variablegroup variablegroups
View All Pages