Jump to

• Request
• Response

Create a library goal

post

/hcmRestApi/resources/11.13.18.05/libraryGoals

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BusinessUnitId: number
  Unique identifier for the business unit associated with the library goal.
• Comments: string
  Title: Comments

  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.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description of the library goal.
• DevCategoryCode: string
  Title: Category

  Maximum Length: 30

  Category code of the development library goal.
• GoalExternalId: string
  Title: External ID

  Maximum Length: 30

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

  Unique identifier for the library goal.
• GoalName(required): string
  Title: Goal Name

  Maximum Length: 700

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

  Subtype code of the library goal.
• GoalUrl: string
  Title: Related Link

  Maximum Length: 4000

  Uniform Resource Locator of the library goal.
• JobFamilyId: number
  Unique identifier for the job family associated with the library goal.
• JobId: number
  Unique identifier for the job associated with the library goal.
• LegalEmployerId: number
  Unique identifier for the legal employer associated with the library goal.
• LevelCode: string
  Maximum Length: 30

  Level code 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.
• libraryGoalsDFF: array libraryGoalsDFF
• 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.
• LongDescription: string (byte)
  Long description of the goal.
• PerfCategoryCode: string
  Title: Category

  Maximum Length: 30

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

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

  Status code 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.
• 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.

{
    "required":[
        "GoalName"
    ],
    "type":"object",
    "properties":{
        "BusinessUnitId":{
            "type":"number",
            "description":"Unique identifier for the business unit associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Comments added to the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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
            }
        },
        "DateTo":{
            "title":"To Date",
            "type":"string",
            "description":"End date of the library goal.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DepartmentId":{
            "type":"number",
            "description":"Unique identifier for the department associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DevCategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category code of the development library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "GoalExternalId":{
            "title":"External ID",
            "maxLength":30,
            "type":"string",
            "description":"Unique external identifier for the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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
            }
        },
        "GoalName":{
            "title":"Goal Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the library goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "GoalSubTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Subtype code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "GoalUrl":{
            "title":"Related Link",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform Resource Locator of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "JobFamilyId":{
            "type":"number",
            "description":"Unique identifier for the job family associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "JobId":{
            "type":"number",
            "description":"Unique identifier for the job associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LegalEmployerId":{
            "type":"number",
            "description":"Unique identifier for the legal employer associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Level code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LongDescription":{
            "type":"string",
            "description":"Long description of the goal.",
            "format":"byte",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerfCategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category code of the performance library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Priority code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the library goal.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SuccessCriteria":{
            "maxLength":4000,
            "type":"string",
            "description":"Success criteria of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"Target completion date of the library goal.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that indicates the type of library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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
            }
        },
        "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-post-request"
            }
        },
        "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-post-request"
            }
        },
        "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-post-request"
            }
        },
        "libraryGoalsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/libraryGoals-libraryGoalsDFF-item-post-request"
            },
            "x-cardinality":"1"
        }
    }
}

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-post-request

{
    "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-post-request"
    }
}

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-post-request

{
    "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-post-request"
    }
}

Nested Schema : libraryGoalsDFF

Type: array

Show Source

• Array of: object libraryGoals-libraryGoalsDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/libraryGoals-libraryGoalsDFF-item-post-request"
    },
    "x-cardinality":"1"
}

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-post-request

{
    "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-post-request"
    }
}

Nested Schema : libraryGoals-libGoalTargetOutcomes-item-post-request

Type: object

Show Source

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

  Unique identifier for the content item added as a target outcome.
• GoalId: integer (int64)
  Title: Content Item ID

  Unique identifier for the goal associated with the 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":{
        "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
            }
        },
        "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
            }
        },
        "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"
        },
        "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
            }
        },
        "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
            }
        }
    }
}

Nested Schema : libraryGoals-libraryGoalMeasures-item-post-request

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.
• 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.
• 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.
• TargetPercentage: number
  Target percentage of the library goal measurement.
• TargetTypeCode: string
  Maximum Length: 30

  Target type code 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.

{
    "type":"object",
    "properties":{
        "ActualValue":{
            "type":"number",
            "description":"Actual value of the library goal's measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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"
            }
        },
        "Comments":{
            "title":"Full Content Item Description",
            "maxLength":4000,
            "type":"string",
            "description":"Comments about the library goal's measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the library goal measurement.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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
            }
        },
        "MaximumTarget":{
            "type":"number",
            "description":"Maximum target of the library goal measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "MeasurementName":{
            "title":"Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the measurement of a library goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "MinimumTarget":{
            "type":"number",
            "description":"Minimum target of the library goal measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the library goal measurement.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TargetPercentage":{
            "type":"number",
            "description":"Target percentage of the library goal measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TargetTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Target type code of the library goal measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TargetValue":{
            "type":"number",
            "description":"Target value of the library goal measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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
            }
        }
    }
}

Nested Schema : libraryGoals-libraryGoalsDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• BusinessGroupId: integer (int64)
  Title: Business Group ID
• ContentItemId: integer (int64)
  Title: Content Item ID

{
    "type":"object",
    "properties":{
        "BusinessGroupId":{
            "title":"Business Group ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "ContentItemId":{
            "title":"Content Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : libraryGoals-libraryGoalTasks-item-post-request

Type: object

Show Source

• AchievedWeight: number
  Achieved weight for the measurement of the library goal's task.
• ActualCompletionDate: string (date)
  Actual completion date for the measurement of the library goal's task.
• ActualValue: number
  Actual value for the measurement of the library goal's task.
• 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.
• CompletionStatus: string
  Maximum Length: 4000

  Completion status for the measurement of the library goal's task.
• GoalId: integer (int64)
  Title: Content Item ID

  Unique identifier for the library goal for which the task applies.
• MaximumTarget: number
  Maximum target for the measurement of the library goal's task.
• MinimumTarget: number
  Minimum target for the measurement of the library goal's task.
• PercentCompletion: string
  Title: Completion Percentage

  Maximum Length: 30

  Completion percentage of the library goal's task.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  Priority code of the library goal's task.
• RelatedLink: string
  Title: Related Link

  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.
• TargetCompletionDate: string (date)
  Target completion date for the library goal's task.
• TargetPercentage: number
  Target percentage for the measurement of the library goal's task.
• TargetType: string
  Maximum Length: 4000

  Code for the target type of the library goal's task.
• TargetValue: number
  Target value of 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
  Title: Type

  Maximum Length: 30

  Task type code of the library goal's task.
• UomCode: string
  Maximum Length: 4000

  Code for the unit of measure of the library goal's task.

{
    "type":"object",
    "properties":{
        "AchievedWeight":{
            "type":"number",
            "description":"Achieved weight for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ActualCompletionDate":{
            "type":"string",
            "description":"Actual completion date for the measurement of the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ActualValue":{
            "type":"number",
            "description":"Actual value for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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"
            }
        },
        "Comments":{
            "title":"Full Content Item Description",
            "maxLength":4000,
            "type":"string",
            "description":"Comments about the library goal task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CompletionStatus":{
            "maxLength":4000,
            "type":"string",
            "description":"Completion status for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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
            }
        },
        "MaximumTarget":{
            "type":"number",
            "description":"Maximum target for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "MinimumTarget":{
            "type":"number",
            "description":"Minimum target for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PercentCompletion":{
            "title":"Completion Percentage",
            "maxLength":30,
            "type":"string",
            "description":"Completion percentage of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"Priority code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "RelatedLink":{
            "title":"Related Link",
            "maxLength":4000,
            "type":"string",
            "description":"Related link of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"Target completion date for the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TargetPercentage":{
            "type":"number",
            "description":"Target percentage for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TargetType":{
            "maxLength":4000,
            "type":"string",
            "description":"Code for the target type of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TargetValue":{
            "type":"number",
            "description":"Target value of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":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"
            }
        },
        "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"
            }
        },
        "TaskName":{
            "title":"Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the task of a library goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TaskTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Task type code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "UomCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Code for the unit of measure of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

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-item-response

Type: object

Show Source

• AvailableTo: string
  Title: Available To

  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
  Title: Comments

  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: Description

  Maximum Length: 4000

  Description of the library goal.
• DevCategoryCode: string
  Title: Category

  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
  Title: External ID

  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: Goal 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
  Title: Related Link

  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
  Title: Legal Employer

  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.
• libraryGoalsDFF: array libraryGoalsDFF
• 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.
• LongDescription: string (byte)
  Long description of the goal.
• PerfCategoryCode: string
  Title: Category

  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: Priority

  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: Status

  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: Type

  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":{
        "AvailableTo":{
            "title":"Available To",
            "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
        },
        "BusinessUnitId":{
            "type":"number",
            "description":"Unique identifier for the business unit associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "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
        },
        "Comments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Comments added to 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
        },
        "DateTo":{
            "title":"To Date",
            "type":"string",
            "description":"End date of the library goal.",
            "format":"date",
            "nullable":true,
            "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
        },
        "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
        },
        "Description":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DevCategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category code of the development library goal.",
            "nullable":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
        },
        "GoalExternalId":{
            "title":"External ID",
            "maxLength":30,
            "type":"string",
            "description":"Unique external identifier for 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
        },
        "GoalName":{
            "title":"Goal Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the library goal.",
            "nullable":false,
            "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
        },
        "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
        },
        "GoalUrl":{
            "title":"Related Link",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform Resource Locator of the library goal.",
            "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
        },
        "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
        },
        "JobId":{
            "type":"number",
            "description":"Unique identifier for the job associated with the 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
        },
        "LegalEmployerId":{
            "type":"number",
            "description":"Unique identifier for the legal employer associated with the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LegalEmployerName":{
            "title":"Legal Employer",
            "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
        },
        "LevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Level code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "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
        },
        "LongDescription":{
            "type":"string",
            "description":"Long description of the goal.",
            "format":"byte",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PerfCategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category code of the performance 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
        },
        "PriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Priority code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PriorityMeaning":{
            "title":"Priority",
            "maxLength":80,
            "type":"string",
            "description":"Priority of the library goal.",
            "nullable":false,
            "readOnly":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
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code of the library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the library goal.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SuccessCriteria":{
            "maxLength":4000,
            "type":"string",
            "description":"Success criteria 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
        },
        "TypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that indicates the type of library goal.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TypeMeaning":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of library goal.",
            "nullable":false,
            "readOnly":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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "libraryGoalsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/libraryGoals-libraryGoalsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : libraryGoalsDFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/libraryGoals-libraryGoalsDFF-item-response"
    },
    "x-cardinality":"1"
}

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: Type

  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":{
        "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
        },
        "ContentTypeName":{
            "title":"Type",
            "maxLength":240,
            "type":"string",
            "description":"Name of the content type added as a target outcome.",
            "nullable":false,
            "readOnly":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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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.
• TargetPercentage: number
  Target percentage 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":{
        "ActualValue":{
            "type":"number",
            "description":"Actual value of the library goal's measurement.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the library goal measurement.",
            "format":"date",
            "nullable":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
        },
        "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
        },
        "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
        },
        "MaximumTarget":{
            "type":"number",
            "description":"Maximum target of the library goal 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
        },
        "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
        },
        "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
        },
        "MinimumTarget":{
            "type":"number",
            "description":"Minimum target of the library goal measurement.",
            "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
        },
        "TargetPercentage":{
            "type":"number",
            "description":"Target percentage 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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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-libraryGoalsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• BusinessGroupId: integer (int64)
  Title: Business Group ID
• ContentItemId: integer (int64)
  Title: Content Item ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "BusinessGroupId":{
            "title":"Business Group ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"Content Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

• AchievedWeight: number
  Achieved weight for the measurement of the library goal's task.
• ActualCompletionDate: string (date)
  Actual completion date for the measurement of the library goal's task.
• ActualValue: number
  Actual value for the measurement of the library goal's task.
• 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.
• CompletionStatus: string
  Maximum Length: 4000

  Completion status for the measurement of the library goal's 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.
• MaximumTarget: number
  Maximum target for the measurement of the library goal's task.
• MinimumTarget: number
  Minimum target for the measurement of the library goal's task.
• PercentCompletion: string
  Title: Completion Percentage

  Maximum Length: 30

  Completion percentage of the library goal's task.
• PriorityCode: string
  Title: Priority

  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
  Title: Related Link

  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.
• TargetPercentage: number
  Target percentage for the measurement of the library goal's task.
• TargetType: string
  Maximum Length: 4000

  Code for the target type of the library goal's task.
• TargetTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Description for the target type of the library goal's task.
• TargetValue: number
  Target value of 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
  Title: Type

  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.
• UomCode: string
  Maximum Length: 4000

  Code for the unit of measure of the library goal's task.
• UomCodeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Unit of measure of the library goal's task.

{
    "type":"object",
    "properties":{
        "AchievedWeight":{
            "type":"number",
            "description":"Achieved weight for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "type":"string",
            "description":"Actual completion date for the measurement of the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActualValue":{
            "type":"number",
            "description":"Actual value for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "CompletionStatus":{
            "maxLength":4000,
            "type":"string",
            "description":"Completion status for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "MaximumTarget":{
            "type":"number",
            "description":"Maximum target for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MinimumTarget":{
            "type":"number",
            "description":"Minimum target for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PercentCompletion":{
            "title":"Completion Percentage",
            "maxLength":30,
            "type":"string",
            "description":"Completion percentage of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"Priority code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "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
        },
        "RelatedLink":{
            "title":"Related Link",
            "maxLength":4000,
            "type":"string",
            "description":"Related link of the library goal's task.",
            "nullable":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
        },
        "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
        },
        "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
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"Target completion date for the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetPercentage":{
            "type":"number",
            "description":"Target percentage for the measurement of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetType":{
            "maxLength":4000,
            "type":"string",
            "description":"Code for the target type of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description for the target type of the library goal's task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetValue":{
            "type":"number",
            "description":"Target value of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "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
        },
        "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
        },
        "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
        },
        "TaskTypeCode":{
            "title":"Type",
            "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
        },
        "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
        },
        "UomCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Code for the unit of measure of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UomCodeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Unit of measure of the library goal's task.",
            "nullable":false,
            "readOnly":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"
            }
        }
    }
}

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

libGoalTargetOutcomes

Operation: /hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libGoalTargetOutcomes

Parameters:

• libraryGoalsUniqID: $request.path.libraryGoalsUniqID

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

libraryGoalMeasures

Operation: /hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalMeasures

Parameters:

• libraryGoalsUniqID: $request.path.libraryGoalsUniqID

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

libraryGoalTasks

Operation: /hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalTasks

Parameters:

• libraryGoalsUniqID: $request.path.libraryGoalsUniqID

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

libraryGoalsDFF

Operation: /hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalsDFF

Parameters:

• libraryGoalsUniqID: $request.path.libraryGoalsUniqID

Back to Top