Jump to

• Request
• Response

Get all library goals

get

/hcmRestApi/resources/11.13.18.05/libraryGoals

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a library goal that matches the primary key criteria specified.
    Finder Variables
    • GoalId; integer; Unique identifier for the library goal.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AvailableTo; string; Indicates the roles that have access to the library goal. The library goal can be made available only to HR specialists, or can also be made available to managers and workers.
  • BusinessUnitId; number; Unique identifier for the business unit associated with the library goal.
  • BusinessUnitName; string; Name of the business unit associated with the library goal.
  • Comments; string; Comments added to the library goal.
  • ContentTypeId; integer; Unique identifier for the content type associated with the library goal.
  • DateTo; string; End date of the library goal.
  • DepartmentId; number; Unique identifier for the department associated with the library goal.
  • DepartmentName; string; Name of the department associated with the library goal.
  • Description; string; Description of the library goal.
  • DevCategoryCode; string; Category code of the development library goal.
  • DevCategoryMeaning; string; Category of the development library goal.
  • GoalExternalId; string; Unique external identifier for the library goal.
  • GoalId; integer; Unique identifier for the library goal.
  • GoalName; string; Name of the library goal.
  • GoalSubTypeCode; string; Subtype code of the library goal.
  • GoalSubTypeMeaning; string; Subtype of the library goal. Subtypes are configured based on business requirements.
  • GoalUrl; string; Uniform Resource Locator of the library goal.
  • JobFamilyId; number; Unique identifier for the job family associated with the library goal.
  • JobFamilyName; string; Name of the job family associated with the library goal.
  • JobId; number; Unique identifier for the job associated with the library goal.
  • LastUpdateDate; string; Date the library goal was last updated.
  • LegalEmployerId; number; Unique identifier for the legal employer associated with the library goal.
  • LegalEmployerName; string; Name of the legal employer associated with the library goal.
  • LevelCode; string; Level code of the library goal.
  • LevelMeaning; string; Level of the library goal.
  • PerfCategoryCode; string; Category code of the performance library goal.
  • PerfCategoryMeaning; string; Category of the performance library goal.
  • PriorityCode; string; Priority code of the library goal.
  • PriorityMeaning; string; Priority of the library goal.
  • StartDate; string; Start date of the library goal.
  • StatusCode; string; Status code of the library goal.
  • StatusMeaning; string; Status of the library goal.
  • SuccessCriteria; string; Success criteria of the library goal.
  • TargetCompletionDate; string; Target completion date of the library goal.
  • TypeCode; string; Code that indicates the type of library goal.
  • TypeMeaning; string; Type of library goal.
  • Visible; string; Indicates who can view the library goal. The goal can be viewed only by the HR specialist, only by the HR specialist and manager, or HR specialist, manager, and worker.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : libraryGoals

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/libraryGoals-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "isCompactViewByDefault":true
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object libraryGoals-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/libraryGoals-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : libraryGoals-item-response

Type: object

Show Source

• AvailableTo: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Indicates the roles that have access to the library goal. The library goal can be made available only to HR specialists, or can also be made available to managers and workers.
• BusinessUnitId: number
  Unique identifier for the business unit associated with the library goal.
• BusinessUnitName: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  Name of the business unit associated with the library goal.
• Comments: string
  Maximum Length: 4000

  Comments added to the library goal.
• ContentTypeId: integer (int64)
  Title: Content Type

  Default Value: 124

  Unique identifier for the content type associated with the library goal.
• DateTo: string (date)
  Title: To Date

  End date of the library goal.
• DepartmentId: number
  Unique identifier for the department associated with the library goal.
• DepartmentName: string
  Title: Department

  Read Only: true

  Maximum Length: 240

  Name of the department associated with the library goal.
• Description: string
  Title: Full Content Item Description

  Maximum Length: 4000

  Description of the library goal.
• DevCategoryCode: string
  Maximum Length: 30

  Category code of the development library goal.
• DevCategoryMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Category of the development library goal.
• GoalExternalId: string
  Maximum Length: 30

  Unique external identifier for the library goal.
• GoalId: integer (int64)
  Title: Content Item ID

  Unique identifier for the library goal.
• GoalName: string
  Title: Name

  Maximum Length: 700

  Name of the library goal.
• GoalSubTypeCode: string
  Maximum Length: 30

  Subtype code of the library goal.
• GoalSubTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Subtype of the library goal. Subtypes are configured based on business requirements.
• GoalUrl: string
  Maximum Length: 4000

  Uniform Resource Locator of the library goal.
• JobFamilyId: number
  Unique identifier for the job family associated with the library goal.
• JobFamilyName: string
  Title: Job Family

  Read Only: true

  Maximum Length: 240

  Name of the job family associated with the library goal.
• JobId: number
  Unique identifier for the job associated with the library goal.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the library goal was last updated.
• LegalEmployerId: number
  Unique identifier for the legal employer associated with the library goal.
• LegalEmployerName: string
  Read Only: true

  Maximum Length: 255

  Name of the legal employer associated with the library goal.
• LevelCode: string
  Maximum Length: 30

  Level code of the library goal.
• LevelMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Level of the library goal.
• libGoalTargetOutcomes: array Library Goal Target Outcomes
  Title: Library Goal Target Outcomes

  The libGoalTargetOutcomes resource is a child of the libraryGoals resource and provides all the target outcomes of library goals.
• libraryGoalMeasures: array Library Goal Measures
  Title: Library Goal Measures

  The libraryGoalMeasures resource is a child of the libraryGoals resource and provides all the measurements for library goals.
• libraryGoalTasks: array Library Goal Tasks
  Title: Library Goal Tasks

  The libraryGoalTasks resource is a child of the libraryGoals resource and provides all the tasks for library goals.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PerfCategoryCode: string
  Maximum Length: 30

  Category code of the performance library goal.
• PerfCategoryMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Category of the performance library goal.
• PriorityCode: string
  Maximum Length: 30

  Priority code of the library goal.
• PriorityMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Priority of the library goal.
• StartDate: string (date)
  Start date of the library goal.
• StatusCode: string
  Maximum Length: 30

  Status code of the library goal.
• StatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status of the library goal.
• SuccessCriteria: string
  Maximum Length: 4000

  Success criteria of the library goal.
• TargetCompletionDate: string (date)
  Target completion date of the library goal.
• TypeCode: string
  Maximum Length: 30

  Code that indicates the type of library goal.
• TypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of library goal.
• Visible: string
  Maximum Length: 30

  Indicates who can view the library goal. The goal can be viewed only by the HR specialist, only by the HR specialist and manager, or HR specialist, manager, and worker.

{
    "type":"object",
    "properties":{
        "libGoalTargetOutcomes":{
            "title":"Library Goal Target Outcomes",
            "type":"array",
            "description":"The libGoalTargetOutcomes resource is a child of the libraryGoals resource and provides all the target outcomes of library goals.",
            "items":{
                "$ref":"#/components/schemas/libraryGoals-libGoalTargetOutcomes-item-response"
            }
        },
        "LevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Level code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Full Content Item Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalExternalId":{
            "maxLength":30,
            "type":"string",
            "description":"Unique external identifier for the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Priority code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ContentTypeId":{
            "title":"Content Type",
            "type":"integer",
            "description":"Unique identifier for the content type associated with the library goal.",
            "format":"int64",
            "nullable":false,
            "default":124,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LevelMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Level of the library goal.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the library goal.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "JobFamilyName":{
            "title":"Job Family",
            "maxLength":240,
            "type":"string",
            "description":"Name of the job family associated with the library goal.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LegalEmployerName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the legal employer associated with the library goal.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LegalEmployerId":{
            "type":"number",
            "description":"Unique identifier for the legal employer associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Visible":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates who can view the library goal. The goal can be viewed only by the HR specialist, only by the HR specialist and manager, or HR specialist, manager, and worker.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "libraryGoalTasks":{
            "title":"Library Goal Tasks",
            "type":"array",
            "description":"The libraryGoalTasks resource is a child of the libraryGoals resource and provides all the tasks for library goals.",
            "items":{
                "$ref":"#/components/schemas/libraryGoals-libraryGoalTasks-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit associated with the library goal.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "JobId":{
            "type":"number",
            "description":"Unique identifier for the job associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier for the library goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "TypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that indicates the type of library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments added to the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"number",
            "description":"Unique identifier for the business unit associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "libraryGoalMeasures":{
            "title":"Library Goal Measures",
            "type":"array",
            "description":"The libraryGoalMeasures resource is a child of the libraryGoals resource and provides all the measurements for library goals.",
            "items":{
                "$ref":"#/components/schemas/libraryGoals-libraryGoalMeasures-item-response"
            }
        },
        "SuccessCriteria":{
            "maxLength":4000,
            "type":"string",
            "description":"Success criteria of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of library goal.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the library goal.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalUrl":{
            "maxLength":4000,
            "type":"string",
            "description":"Uniform Resource Locator of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"Target completion date of the library goal.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "JobFamilyId":{
            "type":"number",
            "description":"Unique identifier for the job family associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PerfCategoryMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Category of the performance library goal.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AvailableTo":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the roles that have access to the library goal. The library goal can be made available only to HR specialists, or can also be made available to managers and workers.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":240,
            "type":"string",
            "description":"Name of the department associated with the library goal.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DevCategoryMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Category of the development library goal.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DevCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Category code of the development library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalName":{
            "title":"Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the library goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DepartmentId":{
            "type":"number",
            "description":"Unique identifier for the department associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalSubTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Subtype of the library goal. Subtypes are configured based on business requirements.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalSubTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Subtype code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PriorityMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Priority of the library goal.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PerfCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Category code of the performance library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the library goal was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateTo":{
            "title":"To Date",
            "type":"string",
            "description":"End date of the library goal.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Library Goal Target Outcomes

Type: array

Title: Library Goal Target Outcomes

The libGoalTargetOutcomes resource is a child of the libraryGoals resource and provides all the target outcomes of library goals.

Show Source

• Array of: object libraryGoals-libGoalTargetOutcomes-item-response

{
    "title":"Library Goal Target Outcomes",
    "type":"array",
    "description":"The libGoalTargetOutcomes resource is a child of the libraryGoals resource and provides all the target outcomes of library goals.",
    "items":{
        "$ref":"#/components/schemas/libraryGoals-libGoalTargetOutcomes-item-response"
    }
}

Nested Schema : Library Goal Measures

Type: array

Title: Library Goal Measures

The libraryGoalMeasures resource is a child of the libraryGoals resource and provides all the measurements for library goals.

Show Source

• Array of: object libraryGoals-libraryGoalMeasures-item-response

{
    "title":"Library Goal Measures",
    "type":"array",
    "description":"The libraryGoalMeasures resource is a child of the libraryGoals resource and provides all the measurements for library goals.",
    "items":{
        "$ref":"#/components/schemas/libraryGoals-libraryGoalMeasures-item-response"
    }
}

Nested Schema : Library Goal Tasks

Type: array

Title: Library Goal Tasks

The libraryGoalTasks resource is a child of the libraryGoals resource and provides all the tasks for library goals.

Show Source

• Array of: object libraryGoals-libraryGoalTasks-item-response

{
    "title":"Library Goal Tasks",
    "type":"array",
    "description":"The libraryGoalTasks resource is a child of the libraryGoals resource and provides all the tasks for library goals.",
    "items":{
        "$ref":"#/components/schemas/libraryGoals-libraryGoalTasks-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : libraryGoals-libGoalTargetOutcomes-item-response

Type: object

Show Source

• ContentItemRlatId: integer (int64)
  Title: Content Item Relationship ID

  Unique identifier for the content item added as a target outcome.
• ContentTypeName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the content type added as a target outcome.
• GoalId: integer (int64)
  Title: Content Item ID

  Unique identifier for the goal associated with the target outcome.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 2000

  Item description of the target outcome.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the target outcome was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Read Only: true

  Maximum Length: 700

  Name of content item added as a target outcome.
• RelationshipCode: string
  Title: Relationship

  Maximum Length: 30

  Default Value: SUPPORTS

  Code that indicates the relationship type of the content item added as a target outcome.
• TypeId: integer (int64)
  Title: Related Content Type

  Unique identifier for the content type added as a target outcome.
• TypeItemId: integer (int64)
  Title: Related Content Item

  Unique identifier for the content item type added as a target outcome.

{
    "type":"object",
    "properties":{
        "TypeId":{
            "title":"Related Content Type",
            "type":"integer",
            "description":"Unique identifier for the content type added as a target outcome.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContentItemRlatId":{
            "title":"Content Item Relationship ID",
            "type":"integer",
            "description":"Unique identifier for the content item added as a target outcome.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "TypeItemId":{
            "title":"Related Content Item",
            "type":"integer",
            "description":"Unique identifier for the content item type added as a target outcome.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship",
            "maxLength":30,
            "type":"string",
            "description":"Code that indicates the relationship type of the content item added as a target outcome.",
            "nullable":true,
            "default":"SUPPORTS",
            "x-queryable":true
        },
        "ContentTypeName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the content type added as a target outcome.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":2000,
            "type":"string",
            "description":"Item description of the target outcome.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the target outcome was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of content item added as a target outcome.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier for the goal associated with the target outcome.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : libraryGoals-libraryGoalMeasures-item-response

Type: object

Show Source

• ActualValue: number
  Actual value of the library goal's measurement.
• BusinessGroupId: integer (int64)
  Title: Business Group ID

  Unique identifier for the business group for which the library goal's measurement applies.
• Comments: string
  Title: Full Content Item Description

  Maximum Length: 4000

  Comments about the library goal's measurement.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the library goal measurement.
• CreationDate: string (date-time)
  Read Only: true

  Date when the library goal measurement was created.
• EndDate: string (date)
  End date of the library goal measurement.
• GoalId: integer (int64)
  Title: Content Item ID

  Unique identifier for the library goal for which the measurement applies.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the library goal measurement was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who the last updated the library goal measurement.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumTarget: number
  Maximum target of the library goal measurement.
• MeasurementContentId: integer (int64)
  Title: Content Item ID

  Unique identifier for the measurement of a library goal used to associate it with its components such as the measurement name, and measurement start date.
• MeasurementId: integer (int64)
  Title: Content Item Relationship ID

  Unique identifier for the measurement of a library goal.
• MeasurementName: string
  Title: Name

  Maximum Length: 700

  Name of the measurement of a library goal.
• MeasureTypeCode: string
  Maximum Length: 30

  Default Value: QUALITATIVE

  Code that indicates the measurement type of the measurement associated with the library goal.
• MinimumTarget: number
  Minimum target of the library goal measurement.
• StartDate: string (date)
  Start date of the library goal measurement.
• TargetTypeCode: string
  Maximum Length: 30

  Target type code of the library goal measurement.
• TargetTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Target type of the library goal measurement.
• TargetValue: number
  Target value of the library goal measurement.
• UomCode: string
  Maximum Length: 30

  Unit of measure code of the library goal's measurement.
• UomMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Unit of measure of the library goal's measurement.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who the last updated the library goal measurement.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the library goal measurement was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Target type of the library goal measurement.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetValue":{
            "type":"number",
            "description":"Target value of the library goal measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the library goal measurement.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Full Content Item Description",
            "maxLength":4000,
            "type":"string",
            "description":"Comments about the library goal's measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MeasureTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that indicates the measurement type of the measurement associated with the library goal.",
            "nullable":true,
            "default":"QUALITATIVE",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MeasurementContentId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier for the measurement of a library goal used to associate it with its components such as the measurement name, and measurement start date.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the library goal measurement.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the library goal measurement.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MaximumTarget":{
            "type":"number",
            "description":"Maximum target of the library goal measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Target type code of the library goal measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActualValue":{
            "type":"number",
            "description":"Actual value of the library goal's measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UomMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Unit of measure of the library goal's measurement.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MeasurementName":{
            "title":"Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the measurement of a library goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessGroupId":{
            "title":"Business Group ID",
            "type":"integer",
            "description":"Unique identifier for the business group for which the library goal's measurement applies.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "UomCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure code of the library goal's measurement.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MeasurementId":{
            "title":"Content Item Relationship ID",
            "type":"integer",
            "description":"Unique identifier for the measurement of a library goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MinimumTarget":{
            "type":"number",
            "description":"Minimum target of the library goal measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the library goal measurement was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier for the library goal for which the measurement applies.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : libraryGoals-libraryGoalTasks-item-response

Type: object

Show Source

• BusinessGroupId: integer (int64)
  Title: Business Group ID

  Unique identifier for the business group for which the library goal's task applies.
• Comments: string
  Title: Full Content Item Description

  Maximum Length: 4000

  Comments about the library goal task.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the library goal task.
• CreationDate: string (date-time)
  Read Only: true

  Date when the library goal task was created.
• GoalId: integer (int64)
  Title: Content Item ID

  Unique identifier for the library goal for which the task applies.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the library goal task was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the library goal task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PercentCompletion: string
  Maximum Length: 30

  Completion percentage of the library goal's task.
• PriorityCode: string
  Maximum Length: 30

  Priority code of the library goal's task.
• PriorityMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Priority of the library goal's task.
• RelatedLink: string
  Maximum Length: 4000

  Related link of the library goal's task.
• StartDate: string (date)
  Start date of the library goal's task.
• StatusCode: string
  Maximum Length: 30

  Status code of the library goal's task.
• StatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status of the library goal's task.
• TargetCompletionDate: string (date)
  Target completion date for the library goal's task.
• TaskContentId: integer (int64)
  Title: Content Item ID

  Unique identifier for the task of a library goal used to associate it with its components such as the task name, and task start date.
• TaskId: integer (int64)
  Title: Content Item Relationship ID

  Unique identifier for the task of a library goal.
• TaskName: string
  Title: Name

  Maximum Length: 700

  Name of the task of a library goal.
• TaskTypeCode: string
  Maximum Length: 30

  Task type code of the library goal's task.
• TaskTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Task type of the library goal's task.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the library goal task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the library goal task was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TaskTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Task type code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the library goal task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TaskId":{
            "title":"Content Item Relationship ID",
            "type":"integer",
            "description":"Unique identifier for the task of a library goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TaskContentId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier for the task of a library goal used to associate it with its components such as the task name, and task start date.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Full Content Item Description",
            "maxLength":4000,
            "type":"string",
            "description":"Comments about the library goal task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Priority code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TaskTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Task type of the library goal's task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the library goal's task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PercentCompletion":{
            "maxLength":30,
            "type":"string",
            "description":"Completion percentage of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"Target completion date for the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the task of a library goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RelatedLink":{
            "maxLength":4000,
            "type":"string",
            "description":"Related link of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessGroupId":{
            "title":"Business Group ID",
            "type":"integer",
            "description":"Unique identifier for the business group for which the library goal's task applies.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PriorityMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Priority of the library goal's task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the library goal task was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier for the library goal for which the task applies.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

findByAdvancedSearchQuery

Operation: /hcmRestApi/resources/11.13.18.05/libraryGoals/action/findByAdvancedSearchQuery

Finds library goals by using advance search query criteria.

Back to Top