REST API - getOrgModel

Request

Format	GET <baseurl>/orgmodel/model/<version>
Path parameters	version: The major version of the organization model for which details are to be displayed. Can be obtained using listOrgModelVersions .
Query parameters	`includeresourcecount=``boolean` (optional): Whether or not the number of resource assignments should be included for entities such as groups and positions. Default = false. `includecalendarrefs=``boolean` (optional):Whether or not calendar references should be included for those entities that hold them. Default = false. `includecandidatequeries=``boolean` (optional):Whether or not candidate query configurations should be included for those positions and groups on which they have been defined. Default = false. `includecextpoints=``boolean` (optional): Whether or not organization extension point configurations should be included. Default = true.

Response

JSON	Returns a JSON representation of the content of the getOrgModelResponse element.
XML	Returns the content of the getOrgModelResponse element (from the OrgModelService schema).

Example

Request

GET <baseurl>/orgmodel/model/3

Response

{

  "xml-fragment": {

    "@model-version": "3",

    "capability": [

      {

        "@guid": "_xI4ikMpPEd64gM7QE8RwxA",

        "@name": "CanTravel",

        "@label": "Employee Can Travel"

      },

      {

        "@guid": "_0K47AMpPEd64gM7QE8RwxA",

        "@name": "ConsultingRate",

        "@label": "Consulting Rate",

        "qualifier": {

          "@guid": "_8flbYPl-Ed6Q1ZnFgJo3zg",

          "@name": "ConsultingRateQualifier",

          "@label": "Consulting Rate Qualifier",

          "@type": "Decimal"

        }

      },

      {

        "@guid": "_BJKvUMpQEd64gM7QE8RwxA",

        "@name": "Degree",

        "@label": "Degree",

        "qualifier": {

          "@guid": "_B55BoMpQEd64gM7QE8RwxA",

          "@name": "DegreeQualifier",

          "@label": "Degree Qualifier",

          "@type": "String"

        }

                  .

                  .

                  .

      {

        "@guid": "_nekK8AEZEd-SRt13X0LOYA",

        "@name": "HireDate",

        "@label": "Hire Date",

        "@type": "Date"

      },

      {

        "@guid": "_XEqXsBhEEeCmceLJKkDRUA",

        "@name": "IsDeveloper",

        "@label": "Is A Developer",

        "@type": "Boolean"

      }

    ]

  }

}