Committing Via Web Browser
If you have limited data to commit, or want to get started quickly, then committing data via your web browser is the best option. If you have a lot of data, then you may want to look more into using the SDKs so that you can more rapidly commit programmatically through the API.
Where Can I Start Committing Data Via My Browser?
Building a commit for your Repo can start from multiple places:
Commit Data - For maximum flexibility you can start from the Commit Data button to add, revise, or retract any type of data in your Repo.
- The Commit Data button can be found:At the top of the Data section of a Repo
On the About page of a Repo
Add Instance - When viewing a Type, you can quickly and easily add an instance of that Type.
Unlike the Commit Data button, Add Instance only allows to add, not revise or retract data. Additionally, they Type that can be committed is only the type related to where the Add Instance button was selected.
The Add Instance functionality can be found:
In the Actions Column on the Type page of a Repo
- In the View Type Modal that appears when you click on a Type name.
Building a Commit
If you are starting from add instance instead of Commit Data, skip to step 3
Select The Type
If you chose to Add new data in step 1, then you will need to choose the Type of the data you wish to add.
If you chose to Revise or Retract Data that was previously committed, then you will need to select the instance that you want to Revise or Retract by providing the Wref (WarmHub Reference.) You can do this by:
Searching for the instance by opening the drop-down
Providing the wid (WarmHub ID)
This can be copied from any instance by clicking the chain link icon
next to the title of that instance.Copying the wid from the standard template of an instance where it is listed as the $wid, just below the description
Creating the link yourself by following this format: http://repo.warmhub.com/{Org}/{Repo}/data/{Type}/{$Id}
If you are retracting an instance, this is the final step.
Input Data
Once you have selected the Type or the Instance, you will see a form that contains all of the properties of the selected Type.
If you are adding Data, then the fields will be empty and ready for you to fill in.
If you are revising data, the currently committed data will be populated in the fields and ready for you to edit. If you have changed or added properties to the type since the previous commit, then some properties may be empty.
Any field whose name ends with a red asterisk, is required to be filled in for the commit to be valid.
Any field that has the "+ Add Another" button, is an array, and you can add as many fields as you need.
Common Fields
$Id - The $Id is the name of the instance you are committing.
It must be URL safe
For Articles and Sources it is required, and must be unique within the Repo
We use the $ in front of Id, to keep the Id namespace available for users, if you need to use for any reason.
$label - the $label allows you to give a non-URL friendly name that contains spaces and special characters. Giving your instance a good $label when you are committing, can help all of your data look and read better by users.
About - This only appears on Evidence and Claims and is the Article(s) that the Assertion is about.
You will need to select the Article instance by providing the Wref (WarmHub Reference.) You can do this by:
Searching for the Article instance by opening the drop-down
Providing the wid (WarmHub ID)
This can be copied from any instance by clicking the chain link icon
next to the title of that instance.Copying the wid from the standard template of an instance where it is listed as the $wid, just below the description
Creating the link yourself by following this format: http://repo.warmhub.com/{Org}/{Repo}/data/{Type}/{$Id}
An Assertion can be about multiple Articles, but they must all be of the same Article Type.
Source - This Only Appears on Evidence and is the source of the Evidence being committed.
You will need to select the Source instance by providing the Wref (WarmHub Reference.) You can do this by:
Searching for the Source instance by opening the drop-down
Providing the wid (WarmHub ID)
This can be copied from any instance by clicking the chain link icon
next to the title of that instance.Copying the wid from the standard template of an instance where it is listed as the $wid, just below the description
Creating the link yourself by following this format: http://repo.warmhub.com/{Org}/{Repo}/data/{Type}/{$Id}
Basis - This Only Appears on Claims and is the list of Assertions (Claims and Evidence) that the Claim being committed is based on.
You will need to select the Assertion instance(s) by providing the Wref (WarmHub Reference.) You can do this by:
Searching for the Source instance by opening the drop-down
Providing the wid (WarmHub ID)
This can be copied from any instance by clicking the chain link icon
next to the title of that instance.Copying the wid from the standard template of an instance where it is listed as the $wid, just below the description
Creating the link yourself by following this format: http://repo.warmhub.com/{Org}/{Repo}/data/{Type}/{$Id}
Click Commit
When you have all the data ready, you can click commit. If your commit was succesful, you will see a "Commit Successful" message in the lower right hand corner of your screen.
At this point, all of the data from the commit, will still be filled in the form on your screen. This can be very helpful if you have adding data for multiple instance of similar structure. You can simply change any fields that are different and click commit again. As long as you want to keep adding data of the same type, there is no reason to go back to step 1.
Copy JSON
Once you have filled in the form, you can copy the JSON for the commit via the button in the upper right hand corner of the form. This can be very helpful for learning to format commits or for troubleshooting commits that you wish to make via the API.
Last updated