Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

System Level :

Please update below list of category definitions with request shared.

  1. eTextbook → obj-cat:etextbook_content_all

  2. Explanation Content → obj-cat:explanation-content_content_all

  3. Learning Resource → obj-cat:learning-resource_content_all

  4. Teacher Resource → obj-cat:teacher-resource_content_all

  5. Course Assessment → obj-cat:course-assessment_content_all

  6. Practice Question Set → obj-cat:practice-question-set_content_all

{
    "request": {
        "objectCategoryDefinition": {
            "forms": {
                "update": {
                    "templateName": "",
                    "required": [],
                    "properties": [
                        {
                            "code": "name",
                            "editable": true,
                            "displayProperty": "Editable",
                            "dataType": "text",
                            "renderingHints": {
                                "class": "sb-g-col-lg-1 required"
                            },
                            "description": "Name",
                            "index": 1,
                            "label": "Name",
                            "required": true,
                            "name": "Name",
                            "inputType": "text",
                            "placeholder": "Name",
                            "validations": [
                                {
                                    "type": "maxLength",
                                    "value": "120",
                                    "message": "Exceeded the limit of 120 characters"
                                },
                                {
                                    "type": "required",
                                    "message": "Name is required"
                                }
                            ]
                        },
                        {
                            "code": "author",
                            "dataType": "text",
                            "description": "Author",
                            "editable": true,
                            "index": 2,
                            "inputType": "text",
                            "label": "Author",
                            "name": "Author",
                            "placeholder": "Author",
                            "tooltip": "Provide name of creator of this content.",
                            "renderingHints": {
                                "class": "sb-g-col-lg-1"
                            },
                            "required": true,
                            "validations": [
                                {
                                    "type": "required",
                                    "message": "Author is required"
                                }
                            ]
                        },
                        {
                            "code": "copyright",
                            "dataType": "text",
                            "description": "Copyright",
                            "editable": true,
                            "index": 3,
                            "inputType": "text",
                            "label": "Copyright and Year:",
                            "name": "Copyright",
                            "placeholder": "Enter Copyright and Year",
                            "tooltip": "If you are an individual, creating original content, you are the copyright holder. If you are creating this  content on behalf of an organisation, the organisation may be the copyright holder. ",
                            "renderingHints": {
                                "class": "sb-g-col-lg-1 required"
                            },
                            "required": true,
                            "validations": [
                                {
                                    "type": "required",
                                    "message": "Copyright is required"
                                }
                            ]
                        },
                        {
                            "code": "license",
                            "visible": true,
                            "editable": true,
                            "displayProperty": "Editable",
                            "dataType": "text",
                            "renderingHints": {
                                "class": "sb-g-col-lg-1 required"
                            },
                            "description": "License",
                            "index": 4,
                            "label": "License",
                            "required": true,
                            "name": "license",
                            "inputType": "select",
                            "placeholder": "license",
                            "tooltip": "Choose the more appropriate Creative commons license for this Content. ",
                            "validations": [
                                {
                                    "type": "required",
                                    "message": "License is required"
                                }
                            ]
                        },
                        {
                            "code": "attributions",
                            "dataType": "list",
                            "description": "Attributions",
                            "editable": true,
                            "index": 5,
                            "inputType": "text",
                            "label": "Attributions",
                            "name": "attribution",
                            "placeholder": "",
                            "tooltip": "If you have relied on another work to create this content, provide the name of that creator and the source of that work.",
                            "renderingHints": {
                                "class": "sb-g-col-lg-1"
                            },
                            "required": false
                        },
                        {
                            "code": "boardIds",
                            "visible": true,
                            "depends": [],
                            "editable": false,
                            "dataType": "list",
                            "sourceCategory": "board",
                            "output": "identifier",
                            "renderingHints": {
                                "class": "sb-g-col-lg-1"
                            },
                            "description": "",
                            "label": "Board",
                            "required": true,
                            "name": "Board",
                            "inputType": "nestedselect",
                            "placeholder": "Select Board"
                        },
                        {
                            "code": "mediumIds",
                            "visible": true,
                            "depends": [],
                            "editable": true,
                            "dataType": "list",
                            "sourceCategory": "medium",
                            "output": "identifier",
                            "renderingHints": {
                                "class": "sb-g-col-lg-1"
                            },
                            "description": "",
                            "label": "Medium(s)",
                            "required": true,
                            "name": "Medium",
                            "inputType": "nestedselect",
                            "placeholder": "Select Medium"
                        },
                        {
                            "code": "gradeLevelIds",
                            "visible": true,
                            "depends": [],
                            "editable": true,
                            "dataType": "list",
                            "sourceCategory": "gradeLevel",
                            "output": "identifier",
                            "renderingHints": {
                                "class": "sb-g-col-lg-1"
                            },
                            "description": "",
                            "label": "Class(es)",
                            "required": true,
                            "name": "Grade Level",
                            "inputType": "nestedselect",
                            "placeholder": "Select Grade"
                        },
                        {
                            "code": "subjectIds",
                            "visible": true,
                            "depends": [],
                            "editable": true,
                            "dataType": "list",
                            "sourceCategory": "subject",
                            "output": "identifier",
                            "renderingHints": {
                                "class": "sb-g-col-lg-1"
                            },
                            "description": "",
                            "label": "Subject(s)",
                            "required": true,
                            "name": "Subject",
                            "inputType": "nestedselect",
                            "placeholder": "Select Subject"
                        },
                        {
                            "code": "contentPolicyCheck",
                            "visible": true,
                            "editable": true,
                            "displayProperty": "Editable",
                            "renderingHints": {
                                "class": "sb-g-col-lg-1 required"
                            },
                            "description": "Content Policy check",
                            "index": 7,
                            "labelHtml": "<p class='font-italic'>I agree that by submitting / publishing this Content, I confirm that this Content complies with prescribed guidelines, including the Terms of Use and Content Policy and that I consent to publish it under the <a class='link font-weight-bold'  href='https://creativecommons.org/licenses' target='_blank'>Creative Commons Framework in </a> accordance with the  <a class='link font-weight-bold'  href='/terms-of-use.html' target='_blank'> Content Policy.</a> I have made sure that I do not violate others' copyright or privacy rights.</p>",
                            "required": true,
                            "name": "contentPolicyCheck",
                            "inputType": "checkbox",
                            "placeholder": "Content Policy Check",
                            "validations": [
                                {
                                    "type": "required",
                                    "message": "Content Policy Check is required"
                                }
                            ]
                        }
                    ]
                }
            }
        }
    }
}

CBSE Tenant:

Please update below list of category definitions with request shared.

  1. eTextbook → obj-cat:etextbook_content_<CBSE_CHANNLE_ID>

  2. Explanation Content → obj-cat:explanation-content_content_<CBSE_CHANNLE_ID>

  3. Learning Resource → obj-cat:learning-resource_content_<CBSE_CHANNLE_ID>

  4. Teacher Resource → obj-cat:teacher-resource_content_<CBSE_CHANNLE_ID>

  5. Course Assessment → obj-cat:course-assessment_content_<CBSE_CHANNLE_ID>

  6. Practice Question Set → obj-cat:practice-question-set_content_<CBSE_CHANNLE_ID>

{
  "request": {
    "objectCategoryDefinition": {
      "forms": {
        "update": {
          "templateName": "",
          "required": [],
          "properties": [
            {
              "code": "name",
              "editable": true,
              "displayProperty": "Editable",
              "dataType": "text",
              "renderingHints": {
                "class": "sb-g-col-lg-1 required"
              },
              "description": "Name",
              "index": 1,
              "label": "Name",
              "required": true,
              "name": "Name",
              "inputType": "text",
              "placeholder": "Name",
              "validations": [
                {
                  "type": "maxLength",
                  "value": "120",
                  "message": "Exceeded the limit of 120 characters"
                },
                {
                  "type": "required",
                  "message": "Name is required"
                }
              ]
            },
            {
              "code": "author",
              "dataType": "text",
              "description": "Author",
              "editable": true,
              "index": 2,
              "inputType": "text",
              "label": "Author",
              "name": "Author",
              "placeholder": "Author",
              "tooltip": "Provide name of creator of this content.",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "required": true,
              "validations": [
                {
                  "type": "required",
                  "message": "Author is required"
                }
              ]
            },
            {
              "code": "copyright",
              "dataType": "text",
              "description": "Copyright",
              "editable": true,
              "index": 3,
              "inputType": "text",
              "label": "Copyright and Year:",
              "name": "Copyright",
              "placeholder": "Enter Copyright and Year",
              "tooltip": "If you are an individual, creating original content, you are the copyright holder. If you are creating this  content on behalf of an organisation, the organisation may be the copyright holder. ",
              "renderingHints": {
                "class": "sb-g-col-lg-1 required"
              },
              "required": true,
              "validations": [
                {
                  "type": "required",
                  "message": "Copyright is required"
                }
              ]
            },
            {
              "code": "license",
              "visible": true,
              "editable": true,
              "displayProperty": "Editable",
              "dataType": "text",
              "renderingHints": {
                "class": "sb-g-col-lg-1 required"
              },
              "description": "License",
              "index": 4,
              "label": "License",
              "required": true,
              "name": "license",
              "inputType": "select",
              "placeholder": "license",
              "tooltip": "Choose the more appropriate Creative commons license for this Content. ",
              "validations": [
                {
                  "type": "required",
                  "message": "License is required"
                }
              ]
            },
            {
              "code": "attributions",
              "dataType": "list",
              "description": "Attributions",
              "editable": true,
              "index": 5,
              "inputType": "text",
              "label": "Attributions",
              "name": "attribution",
              "placeholder": "",
              "tooltip": "If you have relied on another work to create this content, provide the name of that creator and the source of that work.",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "required": false
            },
            {
              "code": "board",
              "visible": true,
              "index": 6,
              "depends": [],
              "editable": false,
              "dataType": "list",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "description": "",
              "label": "Board",
              "required": true,
              "name": "Board",
              "inputType": "nestedselect",
              "placeholder": "Select Board"
            },
            {
              "code": "medium",
              "visible": true,
              "index": 7,
              "depends": [],
              "editable": true,
              "dataType": "list",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "description": "",
              "label": "Medium(s)",
              "required": true,
              "name": "Medium",
              "inputType": "nestedselect",
              "placeholder": "Select Medium"
            },
            {
              "code": "gradeLevel",
              "index": 8,
              "visible": true,
              "depends": [],
              "editable": true,
              "dataType": "list",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "description": "",
              "label": "Class(es)",
              "required": true,
              "name": "Grade Level",
              "inputType": "nestedselect",
              "placeholder": "Select Grade"
            },
            {
              "code": "subject",
              "index": 9,
              "visible": true,
              "depends": [],
              "editable": true,
              "dataType": "list",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "description": "",
              "label": "Subject(s)",
              "required": true,
              "name": "Subject",
              "inputType": "nestedselect",
              "placeholder": "Select Subject"
            },
            {
              "code": "topic",
              "index": 10,
              "visible": true,
              "editable": true,
              "dataType": "list",
              "depends": [
                "subject"
              ],
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "name": "Topic",
              "description": "Choose Topics",
              "inputType": "topicselector",
              "label": "Topic(s)",
              "placeholder": "Select Topic",
              "required": false
            },
            {
              "code": "learningOutcome",
              "dataType": "list",
              "description": "",
              "visible": true,
              "editable": true,
              "index": 11,
              "inputType": "select",
              "label": "Learning Outcome :",
              "name": "Learning Outcome :",
              "placeholder": "Select Learning Outcome",
              "depends": [
                "topic"
              ],
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "required": false
            },
            {
              "code": "contentPolicyCheck",
              "visible": true,
              "editable": true,
              "displayProperty": "Editable",
              "renderingHints": {
                "class": "sb-g-col-lg-1 required"
              },
              "description": "Content Policy check",
              "index": 12,
              "labelHtml": "<p class='font-italic'>I agree that by submitting / publishing this Content, I confirm that this Content complies with prescribed guidelines, including the Terms of Use and Content Policy and that I consent to publish it under the <a class='link font-weight-bold'  href='https://creativecommons.org/licenses' target='_blank'>Creative Commons Framework in </a> accordance with the  <a class='link font-weight-bold'  href='/terms-of-use.html' target='_blank'> Content Policy.</a> I have made sure that I do not violate others' copyright or privacy rights.</p>",
              "required": true,
              "name": "contentPolicyCheck",
              "inputType": "checkbox",
              "placeholder": "Content Policy Check",
              "validations": [
                {
                  "type": "required",
                  "message": "Content Policy Check is required"
                }
              ]
            }
          ]
        }
      }
    }
  }
}

NCERT Tenant and any other tenant that doesn’t have Board in the framework:

{
  "request": {
    "objectCategoryDefinition": {
      "forms": {
        "update": {
          "templateName": "",
          "required": [],
          "properties": [
            {
              "code": "name",
              "editable": true,
              "displayProperty": "Editable",
              "dataType": "text",
              "renderingHints": {
                "class": "sb-g-col-lg-1 required"
              },
              "description": "Name",
              "index": 1,
              "label": "Name",
              "required": true,
              "name": "Name",
              "inputType": "text",
              "placeholder": "Name",
              "validations": [
                {
                  "type": "maxLength",
                  "value": "120",
                  "message": "Exceeded the limit of 120 characters"
                },
                {
                  "type": "required",
                  "message": "Name is required"
                }
              ]
            },
            {
              "code": "author",
              "dataType": "text",
              "description": "Author",
              "editable": true,
              "index": 2,
              "inputType": "text",
              "label": "Author",
              "name": "Author",
              "placeholder": "Author",
              "tooltip": "Provide name of creator of this content.",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "required": true,
              "validations": [
                {
                  "type": "required",
                  "message": "Author is required"
                }
              ]
            },
            {
              "code": "copyright",
              "dataType": "text",
              "description": "Copyright",
              "editable": true,
              "index": 3,
              "inputType": "text",
              "label": "Copyright and Year:",
              "name": "Copyright",
              "placeholder": "Enter Copyright and Year",
              "tooltip": "If you are an individual, creating original content, you are the copyright holder. If you are creating this  content on behalf of an organisation, the organisation may be the copyright holder. ",
              "renderingHints": {
                "class": "sb-g-col-lg-1 required"
              },
              "required": true,
              "validations": [
                {
                  "type": "required",
                  "message": "Copyright is required"
                }
              ]
            },
            {
              "code": "license",
              "visible": true,
              "editable": true,
              "displayProperty": "Editable",
              "dataType": "text",
              "renderingHints": {
                "class": "sb-g-col-lg-1 required"
              },
              "description": "License",
              "index": 4,
              "label": "License",
              "required": true,
              "name": "license",
              "inputType": "select",
              "placeholder": "license",
              "tooltip": "Choose the more appropriate Creative commons license for this Content. ",
              "validations": [
                {
                  "type": "required",
                  "message": "License is required"
                }
              ]
            },
            {
              "code": "attributions",
              "dataType": "list",
              "description": "Attributions",
              "editable": true,
              "index": 5,
              "inputType": "text",
              "label": "Attributions",
              "name": "attribution",
              "placeholder": "",
              "tooltip": "If you have relied on another work to create this content, provide the name of that creator and the source of that work.",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "required": false
            },
            {
              "code": "mediumIds",
              "visible": true,
              "depends": [],
              "editable": true,
              "dataType": "list",
              "sourceCategory": "medium",
              "output": "identifier",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "description": "",
              "label": "Medium(s)",
              "required": true,
              "name": "Medium",
              "inputType": "nestedselect",
              "placeholder": "Select Medium"
            },
            {
              "code": "gradeLevelIds",
              "visible": true,
              "depends": [],
              "editable": true,
              "dataType": "list",
              "sourceCategory": "gradeLevel",
              "output": "identifier",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "description": "",
              "label": "Class(es)",
              "required": true,
              "name": "Grade Level",
              "inputType": "nestedselect",
              "placeholder": "Select Grade"
            },
            {
              "code": "subjectIds",
              "visible": true,
              "depends": [],
              "editable": true,
              "dataType": "list",
              "sourceCategory": "subject",
              "output": "identifier",
              "renderingHints": {
                "class": "sb-g-col-lg-1"
              },
              "description": "",
              "label": "Subject(s)",
              "required": true,
              "name": "Subject",
              "inputType": "nestedselect",
              "placeholder": "Select Subject"
            },
            {
              "code": "contentPolicyCheck",
              "visible": true,
              "editable": true,
              "displayProperty": "Editable",
              "renderingHints": {
                "class": "sb-g-col-lg-1 required"
              },
              "description": "Content Policy check",
              "index": 7,
              "labelHtml": "<p class='font-italic'>I agree that by submitting / publishing this Content, I confirm that this Content complies with prescribed guidelines, including the Terms of Use and Content Policy and that I consent to publish it under the <a class='link font-weight-bold'  href='https://creativecommons.org/licenses' target='_blank'>Creative Commons Framework in </a> accordance with the  <a class='link font-weight-bold'  href='/terms-of-use.html' target='_blank'> Content Policy.</a> I have made sure that I do not violate others' copyright or privacy rights.</p>",
              "required": true,
              "name": "contentPolicyCheck",
              "inputType": "checkbox",
              "placeholder": "Content Policy Check",
              "validations": [
                {
                  "type": "required",
                  "message": "Content Policy Check is required"
                }
              ]
            }
          ]
        }
      }
    }
  }
}
  • No labels