MediaWiki API result

{
    "batchcomplete": "",
    "query": {
        "pages": {
            "858": {
                "pageid": 858,
                "ns": 0,
                "title": "API",
                "revisions": [
                    {
                        "user": "Scott",
                        "timestamp": "2020-12-19T02:59:39Z",
                        "comment": "",
                        "contentformat": "text/x-wiki",
                        "contentmodel": "wikitext",
                        "*": "'''The API was added with release 4.0.1.  The wiki reflects the current status for the 20.01 release.'''\n\nopenDCIM has a RESTful API interface which can be accessed by other applications.\n\nDevelopment of the API is happening in stages, and as such this specification is subject to change.  If you are unfamiliar with what a RESTful API is, a good place to start is the [https://en.wikipedia.org/wiki/Representational_state_transfer Wikipedia Entry].\n\n= openAPI/Swagger Documentation =\n\nWe are actively building out openAPI/Swagger compliant documentation for the API.   Check out https://demo.opendcim.org/api/docs/ for the current documentation.   A few pieces of information will remain\nhere on the wiki, but it will not be the authoritative source.\n\nStarting with version 20.02, the Swagger API documentation is part of the openDCIM distribution and may be found at your $url/api/docs/\n\nIf you are not serving openDCIM at the root of your DNS name, you will need to modify the basePath entry found in api/docs/swagger.yaml to match your path.\n\n= Built-in Features for ALL Routes =\n\nThere isn't really a place in Swagger to denote this, but in nearly every route, you can pass any combination of property->value pairs (in JSON format) to filter based upon that combination.\nAdditionally, if you pass the parameter 'wildcards' (with or without a value assigned) then the search will be performed with SQL standard wildcard symbols.   Finally, if you wish to only\nreturn a subset of attributes, send a comma separated list with the parameter name of 'attributes'.\n\nPOST routes are for modifying existing records - if you wish to retain the existing value for a property, simply do not pass it in your list.    We will only update the properties specified in your payload.\n\n== Data Format ==\n\nopenDCIM data will always be returned in JSON format, with no pagination.  This is open source, so if you need your output in another format, such as XML, you can modify the appropriate function in the application.\n\nThe JSON data is returned in the following format:\n<blockquote>\n{\n: error: '''true''' or '''false''',\n: errorcode:  '''200''', if operation was a success; other dependent upon reason for failure\n: ''resultsetname'' (Varies depending upon request)\n: [{ ''data'' }]\n}\n</blockquote>\n\n\n== Authentication ==\n\nRESTful APIs by definition are stateless, but do still need some form of authentication.  It is suggested that you create a separate account for the API to use, rather than piggy-backing off of an existing user account.\n\n'''At a minimum, the account created for the API must have Global Read Access.'''  Working with the inner guts of openDCIM will certainly increase the risk of data corruption, so it's not something that should be opened up lightly.  If an API call requires a ''Specific Permission'' and is called by an account that does not possess that permission, an error 400 will be returned.\n\n== Apache Authentication ==\n\nIf you have enabled Apache Authentication for your site, you will need to pass login credentials with your API request the same as you would for any web request to the server.  The Sample Script section below shows an example of passing the credentials in this manner.\n\nThis was the only mechanism available prior to version 4.2 of openDCIM.\n\n== LDAP Authentication ==\n\nIf you are running version 4.2 or later of openDCIM and have configured your system to work with LDAP Authentication, you will need to follow a few prerequisite steps.\n\n<ul>\n<li>Create a separate account in the openDCIM User Manager for the API access\n<li>Generate a key for the account\n<li>Pass the APIKey in the headers for all requests to the API\n</ul>\n\nThere are two custom headers that you must pass the information in:\n\n<ul>\n<li>UserID\n<li>APIKey\n</ul>\n\nHeader names are case sensitive, as are User IDs.\n\n= Base URI =\n\nDepending on how you implement your website, this may vary, but most would take on the format of:\n\nhttps://myurl/api/v1 (for Version 1 of the API)\n\nAPI versions will not change often and are not the same as the openDCIM release version.  For example, the API has been at v1 since openDCIM version 4.0 and is still on v1 as of openDCIM version 4.3.  All definitions listed below will assume that they are added on to the base URI.  For example, to get a list of all devices, the full URI would be https://myurl/api/v1/device"
                    }
                ]
            },
            "1": {
                "pageid": 1,
                "ns": 0,
                "title": "Main Page",
                "revisions": [
                    {
                        "user": "Scott",
                        "timestamp": "2023-04-16T21:28:07Z",
                        "comment": "/* Integration */",
                        "contentformat": "text/x-wiki",
                        "contentmodel": "wikitext",
                        "*": "'''Welcome to the openDCIM WIKI'''\n\n== Data Center Management Basics ==\n\nData Centers have been around since the first computers were built, only they weren't called data centers, yet.  However, there's a lot of talk about what exactly constitutes a data center.  Is a closet with 1 computer in it a data center?  What if it's in a cabinet?  How about an office with desktop PC's lined up across shelved?  Is there a minimum size to qualify as a data center?  We, the openDCIM project, have adopted a very simple philosophy around it - if it's important enough for you to want to track it, it's a data center.\n\nThat being said, we have a very wide range of \"clients\" using openDCIM, with a very wide range of experience in data center management.  Some of the fields and prompts in the application make some basic assumptions about the knowledge level of the user.  To help bridge the knowledge gap, we have some helpful information.  Not all of this is directly applicable to openDCIM, but is certainly part of the corpus of knowledge around data center management itself.\n\n[[Glossary|Glossary of Common Terms]]\n\n[[Standards]]\n\n[[Regulations]]\n\n== Client Requirements ==\n* Web browser that is reasonably standards compliant.\n** We do not support Internet Explorer 8 or earlier, in other words\n** Developers regularly test against the latest IE, Chrome, Mozilla, and Safari\n** Some mobile devices (tablets/phones) work decently.  If you want to scan barcodes for input, I suggest looking at Bluetooth enabled scanners (around $200 and up).\n* Javascript must be enabled on your client\n* You must be connected to the network at all times - openDCIM does not work in a batch mode\n\n== Getting started ==\n* Some information about running this Cloud Native (in containers) is at https://wiki.opendcim.org/wiki/index.php/Kubernetes\n* First, make sure that you meet the [[System_Requirements|System Requirements]]\n* Then, download from http://www.opendcim.org/downloads.html\n* Follow the installation instructions in the README file\n** Set up your database\n** Configure openDCIM to talk to your database\n** Log in for the first time.  '''The first user to log in is the default administrator! (when using Apache authentication)'''\n* Follow the [[Configuration]] guide\n* Setting up [[BackgroundJobs|background jobs (cron)]].\n* [[Ubuntu]] 15.04 specific installation notes\n* CentOS [[Installation]] guide\n* Why doesn't [[Translation]] work on my system?  Everything is still in English\n* How to add your [[SiteContact|Site Contact]] information to the login and main pages.\n\nSeveral videos exist on YouTube to guide you through the process of setting up and using openDCIM.  Check it out [http://www.youtube.com/channel/UCdDKR8jKgL_3C9YbH-cwb8Q here].\n\nSpecifically, a video of the installation process is available at:\n\n<youtube>UjNsmSN687g</youtube>\n\n== Upgrading ==\n\n* Simply untar the new version onto your server, configure, and browse to the site.  The install.php will automatically run if it is present.  That being said, however, there are a few more steps involved in a \"best practices\" [[Upgrade|upgrade]].\n\n== Integration ==\n* [[LDAP]] for Authentication and Authorization is available as of version 4.2.\n* [[Modern Authentication|ModernAuth]] is available for configuration of Authorization and Authentication and is highly recommended\n* RESTful [[API]] Documentation\n* [[Repository_Synchronization|Synchronizing Templates with the Repository]]\n* [[Local_Reports|Integrating Local Reports to the Application]]\n\n== Shared Template Repository ==\nOne of the really nice bits about openDCIM is that there is a global online repository where other users can submit Device Templates according to the [[RepositoryGuidelines|guidelines]] and then others can download those templates to their own installation.  As the userbase for openDCIM grows, so does the repository.\n\nDo not request an API Key for the repository unless you are submitting templates to it - there is '''no need for an API key''' if you are only going to pull templates from it.\n\n[https://repository.opendcim.org openDCIM Repository]\n\n== Basic Navigation ==\n* The [[Sidebar]]\n* Data Center [[Map_Navigation|Maps]]\n\n== Site Management ==\n* Managing [[People]]\n* Asset Ownership - [[Departments]]\n** Relationship of [[DepartmentContacts|Department Contacts]]\n* [[BulkOperations|Bulk Load Operations]]\n* Managing [[DataCenters|Data Centers]]\n** Managing [[PowerSources|Power Sources]]\n** Managing [[PowerPanels|Power Panels]]\n** Creating your [[FloorPlan]]\n** Managing [[Cabinets]] (The container itself)\n** [[CabNavigator|Navigating Cabinets]] (The items within the container)\n*** Managing [[PowerDistribution|Power Strips]]\n*** Managing [[Infrastructure]] Components\n* Managing [[Manufacturers]]\n* Managing [[DeviceTemplates|Device Templates]]\n\n== Daily Operations ==\n\n* Entering [[Rack_Requests-Users|Rack Requests (Users)]]\n* Completing [[Rack_Requests-Admins|Rack Requests (Admins)]]\n* Entering New [[Devices|Devices]]\n** Reserving Space\n** Documenting [[PowerConnections|Power Connections]]\n** Documenting [[NetworkConnections|Network Connections]]\n** Creating a [[WorkOrderBuilder|Work Order]]\n* [[MovingDevices|Moving Devices to New Locations]]\n* The [[StorageRoom|Storage Room (Surplus)]]\n\n== Auditing ==\n\n== Reporting =="
                    }
                ]
            }
        }
    }
}