Saba Foundation APIs

• Login

  • List Methods
  • Expand Methods

  • GETGet Certificate/login
    Get Saba Certificate to authenticate user.
    
    

    Parameter	Value	Type	Location	Description
    user		string	header	The Saba username to authenticate.
    password		string	header	The password for that username.
    site		string	header	The Saba site name(This field is now Deprecated).For example, SabaSite

• Locales

  • List Methods
  • Expand Methods

  • GETGet Locales/locales?enabled=:enabled&visible=:visible&id=:id&java_locale=:java_locale&name=:name
    Get Information of Locales
    
    

    Parameter	Value	Type	Location	Description
    enabled		string	query	Get list of enabled locales
    visible		string	query	Get list of visible locales
    id		string	query	Get locale details for mentioned id
    java_locale		string	query	Get locale details for mentioned java_locale
    name		string	query	Get locale details for mentioned name

• Facility

  • List Methods
  • Expand Methods

  • GETGet the meta details of facilities/facility/meta:(:searchFields)
    Returns the meta details of the facilities.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular facility/facility/:id:(:searchFields)
    Returns complete information about a facility based on the Facility's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Facility's ID or Facility no.(Facility no. input -> facility_no%3D15467)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular facility including associations/facility/:id?includeassociation=:includeassociation
    Returns complete information about a facility based on the Facility's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Facility's ID or Facility no.(Facility no. input -> facility_no%3D15467)
    includeassociation		string	query	Indicate association details needs to be returned. Possible value (true / false)

  • GETGet All facilities/facility?count=:count&startPage=:startPage
    Returns all facilities for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Facilities/facility?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the facilities along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new facility/facility/
    Allows creating a new facility.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The name of the facility
    enabled		string	query	Whether the facility is enabled (true or false)
    securityDomain		string	query	The domain for the facility
    contact_name		string	query	The contact person's name for the facility
    facility_no		string	query	The number of the facility
    corporate_no		string	query	The corporate number of the facility
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    address3		string	query	Address 3
    city		string	query	City
    state		string	query	State
    country		string	query	Country
    zip		string	query	Zip
    contact_phone		string	query	Contact phone
    contact_phone2		string	query	Contact phone 2
    contact_email		string	query	Contact email
    contact_fax		string	query	Contact fax
    location_id		string	query	Location's ID
    customValues		string	query	Custom fields
    locale		string	query	Locale
    associations		string	query	Map of associations object detail

  • PUTUpdate the details of a facility and association/facility/:id
    Allows updating an existing facility based on the Facility's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Facility's ID or Facility no.(Facility no. input -> facility_no%3D15467)
    name		string	query	The name of the facility
    enabled		string	query	Whether the facility is enabled (true or false)
    securityDomain		string	query	The domain for the facility
    contact_name		string	query	The contact person's name for the facility
    facility_no		string	query	The number of the facility
    corporate_no		string	query	The corporate number of the facility
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    address3		string	query	address3
    city		string	query	City
    state		string	query	State
    country		string	query	Country
    zip		string	query	Zip
    contact_phone		string	query	Contact phone
    contact_phone2		string	query	Contact phone 2
    contact_email		string	query	Contact email
    contact_fax		string	query	Contact fax
    location_id		string	query	Location's ID
    customValues		string	query	Custom fields
    locale		string	query	Locale
    associations		string	query	Map of associations object detail

  • PUTUpdate the details of a facility/facility/:id
    Allows updating an existing facility based on the Facility's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Facility's ID or Facility no.(Facility no. input -> facility_no%3D15467)
    name		string	query	The name of the facility
    enabled		string	query	Whether the facility is enabled (true or false)
    securityDomain		string	query	The domain for the facility
    contact_name		string	query	The contact person's name for the facility
    facility_no		string	query	The number of the facility
    corporate_no		string	query	The corporate number of the facility
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    address3		string	query	address3
    city		string	query	City
    state		string	query	State
    country		string	query	Country
    zip		string	query	Zip
    contact_phone		string	query	Contact phone
    contact_phone2		string	query	Contact phone 2
    contact_email		string	query	Contact email
    contact_fax		string	query	Contact fax
    location_id		string	query	Location's ID
    customValues		string	query	Custom fields
    locale		string	query	Locale

  • DELETEDelete facility/facility/:id
    Deletes facility.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Facility's ID

  • DELETEDelete facility using facility number/facility/facility_no=:facility_no
    Deletes facility.
    
    

    Parameter	Value	Type	Location	Description
    facility_no		string	query	Facility's number

• Location

  • List Methods
  • Expand Methods

  • GETFind the meta details of locations/location/meta:(:searchFields)
    Returns the meta details of the locations.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular location/location/:id:(:searchFields)
    Returns complete information about a location based on the Location's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Location's ID or Location no.(Location No. input -> loc_no%3D15467)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular location along with associations/location/:id?includeassociation=:includeassociation
    Returns complete information about a location based on the Location's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Location's ID or Location no.(Location No. input -> loc_no%3D15467)
    includeassociation		string	query	Indicate association object details needs to be returned. Possible value (true / false)

  • GETGet All Locations/location?count=:count&startPage=:startPage
    Returns all Locations for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Locations/location?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Locations along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new location/location/
    Allows creating a new location.
    
    

    Parameter	Value	Type	Location	Description
    loc_name		string	query	The location name
    locale		string	query	Locale
    state		string	query	State
    securityDomain		string	query	Security Domain
    city		string	query	City
    dept_id		string	query	Department's ID
    customValues		string	query	Custom Values
    phone1		string	query	Work phone
    phone2		string	query	Home phone
    enabled		string	query	Enabled
    zip		string	query	Zip
    fax		string	query	Fax
    country		string	query	Country
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    loc_no		string	query	Location number
    timezone_id		string	query	Timezone's ID
    associations		string	query	Map of associations object detail

  • PUTUpdate the details of a particular location and association/location/:id
    Allows updating an existing location based on the Location's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Location's ID or Location no.(Location No. input -> loc_no%3D15467)
    loc_name		string	query	The location name
    locale		string	query	Locale
    state		string	query	State
    securityDomain		string	query	Security Domain
    city		string	query	City
    dept_id		string	query	Department's ID
    customValues		string	query	Custom Values
    phone2		string	query	Work phone
    phone1		string	query	Home phone
    enabled		string	query	Enabled
    zip		string	query	Zip
    fax		string	query	Fax
    country		string	query	Country
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    loc_no		string	query	Location number
    timezone_id		string	query	Timezone's ID
    associations		string	query	Map of associations object detail

  • PUTUpdate the details of a particular location/location/:id
    Allows updating an existing location based on the Location's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Location's ID or Location no.(Location No. input -> loc_no%3D15467)
    loc_name		string	query	The location name
    locale		string	query	Locale
    state		string	query	State
    securityDomain		string	query	Security Domain
    city		string	query	City
    dept_id		string	query	Department's ID
    customValues		string	query	Custom Values
    phone2		string	query	Work phone
    phone1		string	query	Home phone
    enabled		string	query	Enabled
    zip		string	query	Zip
    fax		string	query	Fax
    country		string	query	Country
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    loc_no		string	query	Location number
    timezone_id		string	query	Timezone's ID

• Job Family

  • List Methods
  • Expand Methods

  • GETFind the meta details of job families/jobfamily/meta:(:searchFields)
    Returns the meta details of job families.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular Job family/jobfamily/:id:(:searchFields)
    Returns complete information about a Job Family based on the Job Family's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Job Family's ID or Job Family's Name (Job Family Name input -> name%3DJobFamilyTest)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular Job family along with associations/jobfamily/:id?includeassociation=:includeassociation
    Returns complete information about a Job Family based on the Job Family's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Job Family's ID or Job Family's Name (Job Family Name input -> name%3DJobFamilyTest)
    includeassociation		string	query	Indicate association details needs to be returned. Possible value (true / false)

  • GETGet All JobFamilies/jobfamily?count=:count&startPage=:startPage
    Returns all JobFamilies for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the JobFamilies/jobfamily?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the JobFamilies along with the ID, Name and Deeplink ULR based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new Job family/jobfamily/
    Allows creating a new Job Family.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The name of the Job Family
    description		string	query	The short description for the Job Family
    isCareerSiteCategory		string	query	If it is career site category
    associations		string	query	Map of associations object detail

  • PUTUpdate the details of a Job family/jobfamily/:id
    The update method of the Job Family web service allows updating an existing Job Family based on the Job Family's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Job Family's ID or Job Family's Name (Job Family Name input -> name%3DJobFamilyTest)
    name		string	query	The name of the Job Family
    description		string	query	The description for the Job Family
    isCareerSiteCategory		string	query	If it is career site category
    associations		string	query	Map of associations object detail

  • PUTUpdate locale-specific details of job family/jobfamily/:instanceId/locale
    Update locale-specific attributes of job family.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

• Job Type

  • List Methods
  • Expand Methods

  • GETFind the meta details of the Job Types/jobs/meta:(:searchFields)
    Returns the meta details of the Job Types.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of the Job type/jobs/:id:(:searchFields)
    Returns complete information about a Job Type based on the Job Type's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Job Type's ID or Job Code (Job Code Input -> jobCode%3Djob1)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of the Job type along with associations/jobs/:id?includeassociation=:includeassociation
    Returns complete information about a Job Type based on the Job Type's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Job Type's ID or Job Code (Job Code Input -> jobCode%3Djob1)
    includeassociation		string	query	Indicate association object details needs to be returned. Possible value (true / false)

  • GETGet All JobTypes/jobs?count=:count&startPage=:startPage
    Returns all JobTypes for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the JobTypes/jobs?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the JobTypes along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new Job type/jobs/
    Allows creating a new Job Type.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The Job Type
    status		string	query	Status
    locale		string	query	Locale
    family_id		string	query	Family's ID
    securityDomain		string	query	Security Domain
    end_date		string	query	End date
    description		string	query	Description
    customValues		string	query	Custom Values
    responsibilities		string	query	Responsibilities
    is_critical		string	query	Is critical?
    start_date		string	query	Start date
    associations		string	query	Map of associations object detail

  • PUTUpdate the details of a Job type and associations/jobs/:id
    Allows updating an existing Job Type based on the Job Type's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Job Type's ID or Job Code (Job Code Input -> jobCode%3Djob1)
    name		string	query	The Job Type
    status		string	query	Status
    locale		string	query	Locale
    family_id		string	query	Family's ID
    securityDomain		string	query	Security Domain
    end_date		string	query	End date
    description		string	query	Description
    customValues		string	query	Custom Values
    responsibilities		string	query	Responsibilities
    is_critical		string	query	Is critical?
    start_date		string	query	Start date
    associations		string	query	Map of associations object detail

  • PUTUpdate the details of a Job type/jobs/:id
    Allows updating an existing Job Type based on the Job Type's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Job Type's ID or Job Code (Job Code Input -> jobCode%3Djob1)
    name		string	query	The Job Type
    status		string	query	Status
    locale		string	query	Locale
    family_id		string	query	Family's ID
    securityDomain		string	query	Security Domain
    end_date		string	query	End date
    description		string	query	Description
    customValues		string	query	Custom Values
    responsibilities		string	query	Responsibilities
    is_critical		string	query	Is critical?
    start_date		string	query	Start date

  • PUTUpdate locale-specific details of jobtype/jobs/:instanceId/locale
    Update locale-specific attributes of job type.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

• Position

  • List Methods
  • Expand Methods

  • GETGet the meta details of positions/positions/meta:(:searchFields)
    Returns the meta details of the Position.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned

  • GETGet the details of a particular position/position/:id:(:searchFields)
    Returns complete information about a Position based on the position's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Position's ID or Position Id from UI (Position Id input -> position_id%3Dposition1)
    searchFields		string	query	Indicate what additional details needs to be returned

  • GETGet All Positions/positions?count=:count&startPage=:startPage
    Returns all positions for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the positions/positions?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the positions along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new Position/position/
    Creates a new position
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	Input JSON class name
    positionDetail		string	query	Position details
    positionCompensationDetail		string	query	No description

  • POSTFind the details of position (Using POST - Range based search)/positions/searchQuery?count=:count&startPage=:startPage
    Returns the details of the position.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description

  • PUTUpdate the details of a position/position/:id
    Updates an existing position based on the position's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Position's ID or Position Id from UI (Position Id input -> position_id%3Dposition1)
    @type		string	query	Input JSON class name
    positionDetail		string	query	Position details
    positionCompensationDetail		string	query	position compensation details

• Roles

  • List Methods
  • Expand Methods

  • GETGet the meta details of the available roles/role/meta:(:searchFields)
    Returns the meta details of the job roles.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular role/role/:id:(:searchFields)
    Returns complete information about a job role based on the Role's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Role's ID or Role Name (Role Name input -> name%3DRole1)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Roles/role?count=:count&startPage=:startPage
    Returns all Roles for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Roles/role?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Roles along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETGet the details of a particular role including associations of the role/role/:id?includeassociation=:includeassociation
    Returns complete information about a job role based on the Role's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Role's ID or Role Name (Role Name input -> name%3DRole1)
    includeassociation		string	query	Returns the details of associations in the search

  • POSTCreate a new role/role
    Allows creating a new job role.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The name of the role
    description		string	query	The short description about the job role
    securityDomain		string	query	The domain for the facility
    customValues		string	query	Custom Values
    associations		string	query	association input json

  • PUTUpdate the details of a role/role/:id
    Allows updating an existing job role based on the Role ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Role's ID or Role Name (Role Name input -> name%3DRole1)
    name		string	query	The name of the role
    description		string	query	The short description about the job role
    securityDomain		string	query	The domain for the facility
    customValues		string	query	Custom Values

  • PUTUpdate the details of a role including role association/role/:id
    Allows updating an existing job role based on the Role ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Role's ID or Role Name (Role Name input -> name%3DRole1)
    name		string	query	The name of the role
    description		string	query	The short description about the job role
    securityDomain		string	query	The domain for the facility
    customValues		string	query	Custom Values
    associations		string	query	associations input json

  • PUTUpdate locale-specific details of role/role/:instanceId/locale
    Update locale-specific attributes of role.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

• Audience Type

  • List Methods
  • Expand Methods

  • GETFind the meta details of the audience types/audiencetype/meta:(:searchFields)
    Returns the meta details of the audience type.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular audience type/audiencetype/:id:(:searchFields)
    Returns complete information about an Audience Type based on the Audience Type's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Audience Type's ID or Audience Type Name (e.g -> name%3DAudience2)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All AudienceTypes/audiencetype?count=:count&startPage=:startPage
    Returns all AudienceTypes for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the AudienceTypes/audiencetype?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the AudienceTypes along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new audience type/audiencetype
    Allows creating a new Audience Type.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The name of the Audience Type
    description		string	query	The short description about the Audience Type
    precedence		string	query	Precedence
    securityDomain		string	query	The domain for the facility
    customValues		string	query	Custom Values

  • PUTUpdate the details of an audience type/audiencetype/:id
    Allows updating an existing Audience Type based on the Audience Type's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Audience Type's ID or Audience Type Name (e.g -> name%3DAudience2)
    name		string	query	The name of the Audience Type
    description		string	query	The short description about the Audience Type
    precedence		string	query	Precedence
    securityDomain		string	query	The domain for the facility
    customValues		string	query	Custom Values

• Sub audience type

  • List Methods
  • Expand Methods

  • GETFind the meta details of the sub audience types/subaudiencetype/meta:(:searchFields)
    Returns the meta details of the sub audience type.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular sub audience type/subaudiencetype/:id:(:searchFields)
    Returns complete information about a sub audience type based on the sub audience type's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	sub audience type's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All Sub Audience Types/subaudiencetype?count=:count&startPage=:startPage
    Returns all Sub Audience Types for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Sub Audience Types/subaudiencetype?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Sub Audience Types based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of sub audience type (Using POST - Range based search)/subaudiencetype/searchQuery?count=:count&startPage=:startPage
    Returns the details of the sub audience type.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description

  • POSTCreate a new sub audience type/subaudiencetype
    Allows creating a new sub audience type.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The name of the sub audience type
    description		string	query	The short description about the sub audience type
    parent_id		string	query	Parent of sub audience type
    customValues		string	query	Custom Values

  • PUTUpdate the details of an sub audience type/subaudiencetype/:id
    Allows updating an existing sub audience type based on the sub audience type's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	sub audience type's ID
    name		string	query	The name of the sub audience type
    description		string	query	The short description about the sub audience type
    customValues		string	query	Custom Values

• Currency

  • List Methods
  • Expand Methods

  • GETFind the meta details of the currency/currency/meta:(:searchFields)
    Returns the meta details of the currency.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular currency/currency/:id:(:searchFields)
    Returns complete information about a currency based on the currency's id that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Currency's ID or Iso Code of the Currency (e.g -> iso_code%3DUSD)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet all currencies/currency?count=:count&startPage=:startPage
    Returns all currencies available in the system.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the currencies/currency?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the currencies along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of currency (Using POST - Range based search)/currency/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the currency along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Returns the details of the currency in the search

• Currency Exchange Rate

  • List Methods
  • Expand Methods

  • GETFind the meta details of Exchange Rate/exchangerate/meta:(:searchFields)
    Returns the meta details of the Exchange Rate.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular Exchange Rate/exchangerate/:id:(:searchFields)
    Returns complete information about a exchange rate based on the exchange rate's id that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Exchange Rate's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet all Exchange Rates/exchangerate?count=:count&startPage=:startPage
    Returns all exchange rates available in the system.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the exchange rate/exchangerate?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the exchange rates along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of exchange rate (Using POST - Range based search)/exchangerate/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the exchange rate along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Returns the details of the exchange rate in the search

  • POSTCreate a new Exchange Rate/exchangerate
    Create new currency exchange rate.
    
    

    Parameter	Value	Type	Location	Description
    src_id		string	query	The source currency
    dest_id		string	query	The destination currency
    start_date		string	query	Starting date of exchange rate
    end_date		string	query	Ending date of exchange rate
    rate		string	query	Rate
    batch_id		string	query	Exchange rate batch

  • PUTUpdate the rate of a Exchange Rate/exchangerate/:id
    Allows updating an existing exchange rate based on the Exchange Rate's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Exchange Rate's ID
    rate		string	query	Rate

  • DELETEDelete a Exchange Rate/exchangerate/:id
    Deletes a Exchange Rate.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Exchange Rate's ID

• Competency

  • List Methods
  • Expand Methods

  • GETGet the meta details of competencies/competency/meta:(:searchFields)
    Returns the meta details of competencies.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular competency/competency/:id:(:searchFields)
    Returns complete information about a competency based on the Competency's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Competency's ID or Competency Name (Competency Name input -> name%3DtestCompetency)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular competency, inlcuding association details/competency/:id?includeassociation=:includeassociation
    Returns complete information(inlcuding association details) about a competency based on the Competency's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Competency's ID or Competency Name (Competency Name input -> name%3DtestCompetency)
    includeassociation		string	query	Include association details

  • GETGet All Competencies/competency?count=:count&startPage=:startPage
    Returns all Competencies for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Competencies/competency?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the competencies along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new competency/competency/
    Allows creating a new competency.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The name of the competency
    description		string	query	The short description about the competency
    securityDomain		string	query	The domain for the facility
    customValues		string	query	Custom Values
    associations		string	query	association input json

  • PUTUpdate the details of a competency/competency/:id
    Allows updating an existing competency based on the Competency's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Competency's ID or Competency Name (Competency Name input -> name%3DtestCompetency)
    name		string	query	The name of the competency
    description		string	query	The short description about the competency
    securityDomain		string	query	The domain for the facility
    customValues		string	query	Custom Values

  • PUTUpdate the details of a competency with association/competency/:id
    Allows updating an existing competency based on the Competency's ID, supports association update.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Competency's ID or Competency Name (Competency Name input -> name%3DtestCompetency)
    name		string	query	The name of the competency
    description		string	query	The short description about the competency
    securityDomain		string	query	The domain for the facility
    customValues		string	query	Custom Values
    associations		string	query	input association json

  • PUTUpdate locale-specific details of competency/competency/:instanceId/locale
    Update locale-specific attributes of competency.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

• Organization

  • List Methods
  • Expand Methods

  • GETGet the meta details of an organization/organization/meta:(:searchFields)?type=:type
    Returns the meta details of an organization.
    
    

    Parameter	Value	Type	Location	Description
    type	internalexternal	enumerated	query	The type of organization desired
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of an organization/organization/:id:(:searchFields)
    Returns complete information about an Organization based on the Organization's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Organization's ID or Organization Number (Organization Number input -> number%3DtestOrg)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All organizations/organization?type=:type&count=:count&startPage=:startPage
    Returns all organizations
    
    

    Parameter	Value	Type	Location	Description
    type	internalexternal	enumerated	query	The type of organization desired
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Internal/External Organizations/organization?type=:type&q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Internal/External Organizations along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    type	internalexternal	enumerated	query	The type of organization.
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETGet the details of an organization including associations/organization/:id?includeassociation=:includeassociation
    Returns complete information about an Organization based on the Organization's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Organization's ID or Organization Number (Organization Number input -> number%3DtestOrg)
    includeassociation		string	query	Indicate association details needs to be returned. Possible value (true / false)

  • GETGet the details of an organization using number/organization/number=:number?type=:type&includeassociation=:includeassociation
    Returns complete information about an Organization based on the Organization's number that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    number		string	query	Organization's number
    includeassociation		string	query	Indicate association details needs to be returned. Possible value (true / false)
    type	internalexternal	enumerated	query	The type of organization.

  • POSTCreate a new Internal Organization/organization?type=internal
    Allows creating a new Internal Organization.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of the organization
    parent_id		string	query	Parent's ID of the organization
    vertical		string	query	Vertical
    currency_id		string	query	The default currency
    state		string	query	State
    phone2		string	query	Phone 2
    securityDomain		string	query	Security Domain
    phone1		string	query	Phone 1
    aa_id		string	query	AA's ID
    city		string	query	City
    description		string	query	Description
    customValues		string	query	Custom Values
    zip		string	query	Zip
    fax		string	query	Fax
    number		string	query	Number
    country		string	query	Country
    cost_center_no		string	query	Cost center no
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    web_server		string	query	Web server
    contact_id		string	query	Contact's ID
    objectives_administrator		string	query	Objectives administrator
    billAddr1		string	query	Bill Addr 1
    billAddr2		string	query	Bill Addr 2
    billCity		string	query	Bill City
    billState		string	query	Bill State
    billZip		string	query	Bill Zip
    billCountry		string	query	Bill Country
    associations		string	query	Map of associations object detail

  • POSTCreate a new External Organization/organization?type=external
    Allows creating a new External Organization.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of the organization
    parent_id		string	query	Parent's ID of the organization
    vertical		string	query	Vertical
    currency_id		string	query	The default currency
    state		string	query	State
    phone2		string	query	Phone 2
    securityDomain		string	query	Security Domain
    phone1		string	query	Phone 1
    city		string	query	City
    description		string	query	Description
    customValues		string	query	Custom Values
    zip		string	query	Zip
    fax		string	query	Fax
    number		string	query	Number
    country		string	query	Country
    is_active		string	query	Is active?
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    web_server		string	query	Web server
    contact_id		string	query	Contact's ID
    objectives_administrator		string	query	Objectives administrator
    billAddr1		string	query	Bill Addr 1
    billAddr2		string	query	Bill Addr 2
    billCity		string	query	Bill City
    billState		string	query	Bill State
    billZip		string	query	Bill Zip
    billCountry		string	query	Bill Country
    learning_vendor		string	query	Learning vendor
    learning_manufacturer		string	query	Learning manufacturer
    business_typ		string	query	Business type
    max_discount		string	query	Discount applicable for organization
    vat_no		string	query	Vat Number
    associations		string	query	Map of associations object detail

  • PUTUpdate the details of an Internal Organization/organization/:id
    Allows updating an existing Internal Business Organization based on the Organization's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Organization's ID
    name		string	query	Name of the organization
    parent_id		string	query	Parent's ID of the organization
    vertical		string	query	Vertical
    currency_id		string	query	The default currency
    state		string	query	State
    phone2		string	query	Phone 2
    securityDomain		string	query	Security Domain
    phone1		string	query	Phone 1
    aa_id		string	query	AA's ID
    city		string	query	City
    description		string	query	Description
    customValues		string	query	Custom Values
    zip		string	query	Zip
    fax		string	query	Fax
    number		string	query	Number
    country		string	query	Country
    cost_center_no		string	query	Cost center no
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    web_server		string	query	Web server
    contact_id		string	query	Contact ID
    objectives_administrator		string	query	Objectives administrator
    billAddr1		string	query	Bill Addr 1
    billAddr2		string	query	Bill Addr 2
    billCity		string	query	Bill City
    billState		string	query	Bill State
    billZip		string	query	Bill Zip
    billCountry		string	query	Bill Country
    currencies		string	query	Currencies

  • PUTUpdate the details of an Internal Organization using Organization number./organization/number:orgNumber?type=internal
    Allows updating an existing Internal Business Organization based on the Organization's ID.
    
    

    Parameter	Value	Type	Location	Description
    orgNumber		string	query	Organization Number
    name		string	query	Name of the organization
    parent_id		string	query	Parent's ID of the organization
    vertical		string	query	Vertical
    currency_id		string	query	The default currency
    state		string	query	State
    phone2		string	query	Phone 2
    securityDomain		string	query	Security Domain
    phone1		string	query	Phone 1
    aa_id		string	query	AA's ID
    city		string	query	City
    description		string	query	Description
    customValues		string	query	Custom Values
    zip		string	query	Zip
    fax		string	query	Fax
    number		string	query	Number
    country		string	query	Country
    cost_center_no		string	query	Cost center no
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    web_server		string	query	Web server
    contact_id		string	query	Contact ID
    objectives_administrator		string	query	Objectives administrator
    billAddr1		string	query	Bill Addr 1
    billAddr2		string	query	Bill Addr 2
    billCity		string	query	Bill City
    billState		string	query	Bill State
    billZip		string	query	Bill Zip
    billCountry		string	query	Bill Country
    currencies		string	query	Currencies

  • PUTUpdate the details and association of an Internal Organization/organization/:id
    Allows updating an existing Internal Business Organization based on the Organization's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Organization's ID
    name		string	query	Name of the organization
    parent_id		string	query	Parent's ID of the organization
    vertical		string	query	Vertical
    currency_id		string	query	The default currency
    state		string	query	State
    phone2		string	query	Phone 2
    securityDomain		string	query	Security Domain
    phone1		string	query	Phone 1
    aa_id		string	query	AA's ID
    city		string	query	City
    description		string	query	Description
    customValues		string	query	Custom Values
    zip		string	query	Zip
    fax		string	query	Fax
    number		string	query	Number
    country		string	query	Country
    cost_center_no		string	query	Cost center no
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    web_server		string	query	Web server
    contact_id		string	query	Contact ID
    objectives_administrator		string	query	Objectives administrator
    billAddr1		string	query	Bill Addr 1
    billAddr2		string	query	Bill Addr 2
    billCity		string	query	Bill City
    billState		string	query	Bill State
    billZip		string	query	Bill Zip
    billCountry		string	query	Bill Country
    currencies		string	query	Currencies
    associations		string	query	Map of associations object detail

  • PUTUpdate the details and association of an Internal Organization using Organization number./organization/number=:orgNumber?type=internal
    Allows updating an existing Internal Business Organization based on the Organization's ID.
    
    

    Parameter	Value	Type	Location	Description
    orgNumber		string	query	Organization Number
    name		string	query	Name of the organization
    parent_id		string	query	Parent's ID of the organization
    vertical		string	query	Vertical
    currency_id		string	query	The default currency
    state		string	query	State
    phone2		string	query	Phone 2
    securityDomain		string	query	Security Domain
    phone1		string	query	Phone 1
    aa_id		string	query	AA's ID
    city		string	query	City
    description		string	query	Description
    customValues		string	query	Custom Values
    zip		string	query	Zip
    fax		string	query	Fax
    number		string	query	Number
    country		string	query	Country
    cost_center_no		string	query	Cost center no
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    web_server		string	query	Web server
    contact_id		string	query	Contact ID
    objectives_administrator		string	query	Objectives administrator
    billAddr1		string	query	Bill Addr 1
    billAddr2		string	query	Bill Addr 2
    billCity		string	query	Bill City
    billState		string	query	Bill State
    billZip		string	query	Bill Zip
    billCountry		string	query	Bill Country
    currencies		string	query	Currencies
    associations		string	query	Map of associations object detail

  • PUTUpdate the details and association of an External Organization /organization/:id
    Allows updating an existing External Business Organization based on the Organization's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Organization's ID
    name		string	query	Name of the organization
    parent_id		string	query	Parent's ID of the organization
    vertical		string	query	Vertical
    currency_id		string	query	The default currency
    state		string	query	State
    phone2		string	query	Phone 2
    securityDomain		string	query	Security Domain
    phone1		string	query	Phone 1
    city		string	query	City
    description		string	query	Description
    customValues		string	query	Custom Values
    zip		string	query	Zip
    currencies		string	query	Currencies
    fax		string	query	Fax
    number		string	query	Number
    country		string	query	Country
    is_active		string	query	Is active?
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    web_server		string	query	Web server
    contact_id		string	query	Contact's ID
    objectives_administrator		string	query	Objectives administrator
    billAddr1		string	query	Bill Addr 1
    billAddr2		string	query	Bill Addr 2
    billCity		string	query	Bill City
    billState		string	query	Bill State
    billZip		string	query	Bill Zip
    billCountry		string	query	Bill Country
    learning_vendor		string	query	Learning vendor
    learning_manufacturer		string	query	Learning manufacturer
    business_typ		string	query	Business type
    max_discount		string	query	Discount applicable for organization
    associations		string	query	Map of associations object detail

  • PUTUpdate the details and association of an External Organization using Organization number./organization/number=:orgNumber?type=external
    Allows updating an existing External Business Organization based on the Organization's ID.
    
    

    Parameter	Value	Type	Location	Description
    orgNumber		string	query	Organization Number
    name		string	query	Name of the organization
    parent_id		string	query	Parent's ID of the organization
    vertical		string	query	Vertical
    currency_id		string	query	The default currency
    state		string	query	State
    phone2		string	query	Phone 2
    securityDomain		string	query	Security Domain
    phone1		string	query	Phone 1
    city		string	query	City
    description		string	query	Description
    customValues		string	query	Custom Values
    zip		string	query	Zip
    currencies		string	query	Currencies
    fax		string	query	Fax
    number		string	query	Number
    country		string	query	Country
    is_active		string	query	Is active?
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    web_server		string	query	Web server
    contact_id		string	query	Contact's ID
    objectives_administrator		string	query	Objectives administrator
    billAddr1		string	query	Bill Addr 1
    billAddr2		string	query	Bill Addr 2
    billCity		string	query	Bill City
    billState		string	query	Bill State
    billZip		string	query	Bill Zip
    billCountry		string	query	Bill Country
    learning_vendor		string	query	Learning vendor
    learning_manufacturer		string	query	Learning manufacturer
    business_typ		string	query	Business type
    max_discount		string	query	Discount applicable for organization
    associations		string	query	Map of associations object detail

  • PUTUpdate the details of an External Organization/organization/:id
    Allows updating an existing External Business Organization based on the Organization's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Organization's ID
    name		string	query	Name of the organization
    parent_id		string	query	Parent's ID of the organization
    vertical		string	query	Vertical
    currency_id		string	query	The default currency
    state		string	query	State
    phone2		string	query	Phone 2
    securityDomain		string	query	Security Domain
    phone1		string	query	Phone 1
    city		string	query	City
    description		string	query	Description
    customValues		string	query	Custom Values
    zip		string	query	Zip
    currencies		string	query	Currencies
    fax		string	query	Fax
    number		string	query	Number
    country		string	query	Country
    is_active		string	query	Is active?
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    web_server		string	query	Web server
    contact_id		string	query	Contact's ID
    objectives_administrator		string	query	Objectives administrator
    billAddr1		string	query	Bill Addr 1
    billAddr2		string	query	Bill Addr 2
    billCity		string	query	Bill City
    billState		string	query	Bill State
    billZip		string	query	Bill Zip
    billCountry		string	query	Bill Country
    learning_vendor		string	query	Learning vendor
    learning_manufacturer		string	query	Learning manufacturer
    business_typ		string	query	Business type
    max_discount		string	query	Discount applicable for organization
    vat_no		string	query	Vat Number

  • PUTUpdate the details of an External Organization using Organization number/organization/number=:orgNumber?type=external
    Allows updating an existing External Business Organization based on the Organization's ID.
    
    

    Parameter	Value	Type	Location	Description
    orgNumber		string	query	Organization Number
    name		string	query	Name of the organization
    parent_id		string	query	Parent's ID of the organization
    vertical		string	query	Vertical
    currency_id		string	query	The default currency
    state		string	query	State
    phone2		string	query	Phone 2
    securityDomain		string	query	Security Domain
    phone1		string	query	Phone 1
    city		string	query	City
    description		string	query	Description
    customValues		string	query	Custom Values
    zip		string	query	Zip
    currencies		string	query	Currencies
    fax		string	query	Fax
    number		string	query	Number
    country		string	query	Country
    is_active		string	query	Is active?
    addr1		string	query	Address 1
    addr2		string	query	Address 2
    email		string	query	Email
    addr3		string	query	Address 3
    web_server		string	query	Web server
    contact_id		string	query	Contact's ID
    objectives_administrator		string	query	Objectives administrator
    billAddr1		string	query	Bill Addr 1
    billAddr2		string	query	Bill Addr 2
    billCity		string	query	Bill City
    billState		string	query	Bill State
    billZip		string	query	Bill Zip
    billCountry		string	query	Bill Country
    learning_vendor		string	query	Learning vendor
    learning_manufacturer		string	query	Learning manufacturer
    business_typ		string	query	Business type
    max_discount		string	query	Discount applicable for organization
    vat_no		string	query	Vat Number

• Note

  • List Methods
  • Expand Methods

  • GETFind the meta details of notes/note/meta:(:searchFields)
    Returns the meta details of the notes
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETFind the details of Notes for a given reference ID/note?q=(owner_id%3D%3D:referenceId)&count=:count&startPage=:startPage
    Returns the details of the notes along with the IDs. You can filter the results using the note's reference ID.
    
    

    Parameter	Value	Type	Location	Description
    referenceId		string	query	Note's Reference ID
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Note for a given note ID/note/:id:(:searchFields)
    Returns the details of the note along with the IDs. You can filter the results using the note's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Note's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETFind the details of the Notes/note?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Notes along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new note/note/
    Allows creating a new note.
    
    

    Parameter	Value	Type	Location	Description
    note1		string	query	Note
    category		string	query	Category of the note
    owner_id		string	query	Owner's ID

• Attachment

  • List Methods
  • Expand Methods

  • GETFind all attachments/attachments?ownerName=:ownerName&ownerId=:ownerId
    Returns all attachments for a given reference ID.
    
    

    Parameter	Value	Type	Location	Description
    ownerName		string	query	Component Name of Owner
    ownerId		string	query	Reference's ID of the attachment

  • GETFind all public/private attachments/attachments?ownerName=:ownerName&ownerId=:ownerId&isPrivate=:isPrivate
    Returns all public/private attachments for a given reference ID.
    
    

    Parameter	Value	Type	Location	Description
    ownerName		string	query	Component Name of Owner
    ownerId		string	query	Reference's ID of the attachment
    isPrivate	truefalse	enumerated	query	Flag to get public/private attachments.

  • GETFind the details of the attachment for a given ID/attachments/attachment/:id/detail
    Returns the details of the attachments along with the IDs. You can filter the results using the attachment's reference ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Attachment's ID

  • GETGet actual content of an attachment/attachments/attachment/:id
    Returns the contents of the attachment based on the Attachment's ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Attachment's ID

  • PUTUpdates an attachment/attachments/:id
    Updates an attachment
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	Type of class
    id		string	query	Attachement's ID
    owner-id		string	query	Owner's ID Or combination of ownerName=displayName like Location=Location1
    is-private		string	query	Whether the attachment is private
    attachment-name		string	query	Name of the attachment
    category		string	query	Category
    file-name		string	query	Filename of the attachment
    mime-type		string	query	Mime-type
    url		string	query	URL
    is-url		string	query	Whether the attachment is a URL (true/false)
    locale		string	query	Locale

• Security Domain

  • List Methods
  • Expand Methods

  • GETGet the security domain's metadata/domain/meta:(:searchFields)
    Returns the security domain's metadata.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet all security domains/domain?count=:count&startPage=:startPage
    Returns all security domains for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETGet the details of a particular security domain/domain/:id:(:searchFields)
    Returns the details of a particular security domain.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Domain's ID or Domain's name (Domain's name e.g -> name%3Ddomain1)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet Attachment Resource/attachments/content/id:(:attachmentId)
    Get information of attachment resource
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Get attachment details for mentioned id

  • DELETEDelete Attachment Resource/attachments/content/id:(:attachmentId)
    Delete information of attachment resource
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	delete attachment for mentioned id

  • GETGet all attachements for mentioned object/attachments/attachment/content/id:(:ownerId)
    get information of all attachments for object
    
    

    Parameter	Value	Type	Location	Description
    ownerId		string	query	get all attachments for mentioned id

• Security Role

  • List Methods
  • Expand Methods

  • GETGet the security role's metadata/securityrole/meta:(:searchFields)
    Returns the security role's metadata.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All security roles/securityrole?count=:count&startPage=:startPage
    Returns all the security roles for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETSearch security roles/securityrole?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns all the security roles as per query param for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.

  • GETGet the details of a particular security role/securityrole/:id:(:searchFields)
    Returns the details of a particular security role.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Role's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

• Timezone

  • List Methods
  • Expand Methods

  • GETGet the timezone's metadata/timezone/meta:(:searchFields)
    Returns the timezone's metadata.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet all the timezones/timezone?count=:count&startPage=:startPage
    Returns all the timezones for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETGet the details of a particular timezone/timezone/:id:(:searchFields)
    Returns the details of a particular timezone.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	timezone's ID or timezone name (timezone name e.g-> name%3DGMTZone)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

• Smart List

  • List Methods
  • Expand Methods

  • GETGet meta detail of key and operator of smartlist/smartlists/meta
    Returns the details of key and operator available for smartlist criteria.
    
    
  • GETGet all the smartlists/smartlists?count=:count&startPage=:startPage
    Returns all the smartlists for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of smartlists/smartlists?q=(:criteria_fields)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns all the smartlists with matching search filter.
    
    

    Parameter	Value	Type	Location	Description
    criteria_fields		string	query	The search criteria like name
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Include details of search record.possible values true/false

  • GETGet the details of a particular smartlist/smartlists/:id
    Returns the details of a particular smartlist.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	smartlist's ID

  • GETGet the person's matching criteria of a particular smartlist/smartlists/:id/member?f=:searchFields&count=:count&startPage=:startPage
    Returns the person's matching criteria of a particular smartlist.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	smartlist's ID
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    searchFields		string	query	The fields to be displayed in output.

  • POSTCreate a new Smartlist/smartlists
    Create new Smartlist.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The name of the Smartlist
    description		string	query	Description of Smartlist
    split		string	query	The domain for the Smartlist
    criteria		string	query	Criteria of Smartlist

  • POSTAdd smartlist as criteria for Audience Type/smartlists/addOwner
    Add smartlist as criteria for Audience Type
    
    

    Parameter	Value	Type	Location	Description
    parent		string	query	The Smartlist used as criteria
    owner		string	query	Audience type

  • PUTUpdate Smartlist/smartlists/:id
    Update Smartlist.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Smartlist Id for update
    name		string	query	The name of the Smartlist
    description		string	query	Description of Smartlist
    split		string	query	The domain for the Smartlist
    criteria		string	query	Criteria of Smartlist

  • PUTUpdate locale-specific details of smartlist/smartlists/:instanceId/locale
    Update locale-specific attributes of smartlist.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

  • DELETEDelete Smartlist/smartlists/:id
    Delete Smartlist.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Smartlist Id for delete

• Data Extract

  • List Methods
  • Expand Methods

  • GETGet the list of data extract jobs/dataextract/jobsList?count=:count&startPage=:startPage
    Returns available list of data extract jobs.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTSchedule data extract job/dataextract/job/:id/scheduleJob
    Schedules data extract jobs.
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type of request body
    id		string	query	Data Extract job ID
    occurenceType	DAILYWEEKLYMONTHLY	enumerated	query	Frequency of data extract
    startDate		string	query	Start Date of data extract.
    endDate		string	query	End Date of data extract.
    dayOfMonth		string	query	Used only for monthly extract. Value can be from 1 to 31.
    weeklyMask		string	query	Used only for weekly extract. First bit represents Monday

• LOVs for an attribute

  • List Methods
  • Expand Methods

  • GETGet list value/lov/:id
    Returns the list value detail
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	The Id of the list value

  • GETGet list value by list id and list value name/lov/:id/:name
    Returns the list value detail
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	listId
    name		string	query	Name of the list value

  • GETGet List Values/lov?q=(:criteria)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the list value detail
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. the criteria field name with search value.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Returns the details of the Session Templates in the search

  • POSTAdd value to LOV for an attribute/lov
    
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	type list entry detail
    name		string	query	The name of the list value
    description		string	query	Description of the list value
    lovList		string	query	List Id and displayName

  • PUTUpdate value of List/lov/:id
    Updating the value of a list is supported by either providing the list value id or list value name
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Id of the value of the list
    @type		string	query	type list entry detail
    name		string	query	The name of the list value
    description		string	query	Description of the list value
    lovList		string	query	List Id and displayName

  • DELETEDelete item from list/lov/:id
    Delete item from list
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	id of the value of the list

  • DELETEDelete item from list (by listid and name of the list value)/lov/:id/:name
    Delete item from list
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	list id
    name		string	query	name of the list value

• Country

  • List Methods
  • Expand Methods

  • GETGet the meta details of the country/country/meta:(:searchFields)
    Returns the meta details of the country
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular country/country/:id
    Returns complete information about a country based on the Country's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Country's Id

  • GETGet All Countries/country?count=:count&startPage=:startPage
    Returns all Countries for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Country/country?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Country along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new Country/country
    Allows creating a new Country.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The name of the Country
    isoCode		string	query	The ISO code for the country
    shortName		string	query	The short name for the country
    active		string	query	Is active

  • PUTUpdate the details of a country/country/:id
    Allows updating an existing country based on the Role ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Country's Id
    name		string	query	The name of the country
    isoCode		string	query	The ISO code of country
    shortName		string	query	shortName
    active		string	query	Is active

  • PUTUpdate locale-specific details of country/country/:instanceId/locale
    Update locale-specific attributes of country.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

  • DELETEDelete country/country/:id
    Deletes Country
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Country's ID

• State

  • List Methods
  • Expand Methods

  • GETGet the meta details of the state/state/meta:(:searchFields)
    Returns the meta details of the state
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular state/state/:id
    Returns complete information about a state based on the State's ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	State's Id

  • GETGet All States/state?count=:count&startPage=:startPage
    Returns all States for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the State/state?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the State along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new State/state
    Allows creating a new State.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The name of the State
    isoCode		string	query	The ISO code for the state
    shortName		string	query	The short name for the state
    country		string	query	The country for the state

  • PUTUpdate the details of a state/state/:id
    Allows updating an existing state based on the Role ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Country's Id
    name		string	query	The name of the country
    isoCode		string	query	The ISO code of country
    shortName		string	query	shortName
    country		string	query	Country

  • PUTUpdate locale-specific details of state/state/:instanceId/locale
    Update locale-specific attributes of state.
    
    

    Parameter	Value	Type	Location	Description
    instanceId		string	query	instance id of component
    details		string	query	details

  • DELETEDelete state/state/:id
    Deletes State
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	State's ID

• Global Search

  • List Methods
  • Expand Methods

  • POSTGlobal search/globalsearch?count=:count&startPage=:startPage
    Returns the global search result.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    searchText		string	query	Search text
    searchContext	ALLBLOGSBOOKMARKLISTCENTRAEVENTCHANNELSVIDEOCONTENTDISCUSSIONMESSAGEEVENTFILEGROUPIDEAISSUEURLPAGEJOBREQUISITIONLEARNINGEVENTSUBSCRIPTIONPERSON	enumerated	query	Search Context
    learningEventType	CERTIFICATIONCURRICULUMCOURSEPACKAGEOFFERING	enumerated	query	Learning event type advance search filter for learning event.
    deliveryType		string	query	Delivery type advance search filter for learning event.
    startDate		string	query	Start date advance search filter for learning event. Date format: YYYY-MM-DDTHH:mm:ssZ
    location		string	query	Location advance search filter for learning event.
    category		string	query	Category based advance search
    tag		string	query	Tag based advance search
    owner		string	query	Owner of resource
    sortBy	RatingHighToLowRatingLowToHighRecentlyAddedRecentlyModifiedAlphaAZAlphaZAMostCommentedMostShared	enumerated	query	Sort method. Default value is relevance.

• Language

  • List Methods
  • Expand Methods

  • GETGet the details of a particular language with search fields/language/:id:(:searchFields)
    Returns complete information about a language based on the language ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Language ID or language Name (language Name input -> name%3DHindi)
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the details of a particular language/language/:id
    Returns complete information about a language based on the language ID that is passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Language ID or language Name (language Name input -> name%3DHindi)

  • GETGet All Languages/language?count=:count&startPage=:startPage
    Returns all Languages for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the Language/language?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the Language along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new Language/language/
    Allows creating a new language.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	The name of the language
    isEnabled		string	query	Value to set language enable

  • PUTUpdate the details of a language/language/:id
    Allows updating an existing language based on the language ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	language ID or language Name (Language Name input -> name%3DHindi)
    name		string	query	The name of the language
    isEnabled		string	query	Set enable true or false

• IP Management

  • List Methods
  • Expand Methods

  • GETGet All IPs/ipmanagement/list?microSiteKey=:microSiteKey&type=:type&pageSize=:pageSize&pageNumber=:pageNumber
    Returns all IPs for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    pageSize		string	query	The number of records per page.
    pageNumber		string	query	The start page number for the list of records.
    microSiteKey		string	query	microsite url identifier. Specify default for default microsite.
    type		string	query	IP list type valid values are denylist and allowlist.

  • POSTCreate a new IP range/ipmanagement/add?copyToMicroSite=:copyToMicroSite
    Add new IP range for microsites.
    
    

    Parameter	Value	Type	Location	Description
    microSite		string	query	microsite url identifier. Specify default for default microsite.
    type		string	query	IP list type valid values are denylist and allowlist.
    fromIP		string	query	IP address for from IP
    toIP		string	query	IP address for to IP
    copyToMicroSite		string	query	Flag to copying on microsite. Default value is false.

  • DELETEDelete Ip range for microsite/ipmanagement/delete?microSiteKey=:microSiteKey&type=:type&fromIP=:fromIP&toIP=:toIP&deleteFromMicroSites=:deleteFromMicroSites
    Allows updating an existing language based on the language ID.
    
    

    Parameter	Value	Type	Location	Description
    microSiteKey		string	query	microsite url identifier. Specify default for default microsite.
    fromIP		string	query	IP address for from IP
    toIP		string	query	IP address for to IP
    type		string	query	IP list type valid values are denylist and allowlist.
    deleteFromMicroSites		string	query	Flag to deleting from microsites. Default value is false.