Jump to

• Request
• Response

Get a curriculum build status

get

/fscmRestApi/resources/11.13.18.05/curriculumBuildStatuses/{CurriculumBuildStatusId}

Request

Path Parameters

• CurriculumBuildStatusId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : curriculumBuildStatuses-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the build status is active or inactive.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the build status.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the build status was created.
• CurriculumBuildStatusCode: string
  Title: Build Status Code

  Maximum Length: 30

  The unique code identifier for the curriculum build status.
• CurriculumBuildStatusId: integer (int64)
  Title: Curriculum Build Status ID

  The unique identifier for a build status for curriculum items.
• CurriculumBuildStatusName: string
  Title: Build Status

  Maximum Length: 50

  The name of a user defined build or lifecycle status code.
• curriculumTypes: array Curriculum Types
  Title: Curriculum Types

  The curriculum types resource is a child of the curriculum build statuses resource and lists all the curriculum types that can use this curriculum build status.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of a curriculum build status.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the build status was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the build status.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SortNumber: integer (int32)
  Title: Sort Order

  The display order for the build status.
• SystemStatusCode: string
  Title: Curriculum Build Status

  Maximum Length: 30

  The status of the curriculum build status in relation to a curriculum item. Values are ORA_ACTIVE or ORA_INACTIVE.
• SystemStatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the status of the curriculum build status in relation to a curriculum item. Values are Active or Inactive.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the build status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the build status was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the build status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a curriculum build status.",
            "nullable":false,
            "x-queryable":true
        },
        "CurriculumBuildStatusId":{
            "title":"Curriculum Build Status ID",
            "type":"integer",
            "description":"The unique identifier for a build status for curriculum items.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SystemStatusCode":{
            "title":"Curriculum Build Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the curriculum build status in relation to a curriculum item. Values are ORA_ACTIVE or ORA_INACTIVE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "curriculumTypes":{
            "title":"Curriculum Types",
            "type":"array",
            "description":"The curriculum types resource is a child of the curriculum build statuses resource and lists all the curriculum types that can use this curriculum build status.",
            "items":{
                "$ref":"#/components/schemas/curriculumBuildStatuses-curriculumTypes-item-response"
            }
        },
        "CurriculumBuildStatusCode":{
            "title":"Build Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code identifier for the curriculum build status.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the build status is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "SystemStatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the status of the curriculum build status in relation to a curriculum item. Values are Active or Inactive.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumBuildStatusName":{
            "title":"Build Status",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a user defined build or lifecycle status code.",
            "nullable":false,
            "x-queryable":true
        },
        "SortNumber":{
            "title":"Sort Order",
            "type":"integer",
            "description":"The display order for the build status.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the build status was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Curriculum Types

Type: array

Title: Curriculum Types

The curriculum types resource is a child of the curriculum build statuses resource and lists all the curriculum types that can use this curriculum build status.

Show Source

• Array of: object curriculumBuildStatuses-curriculumTypes-item-response

{
    "title":"Curriculum Types",
    "type":"array",
    "description":"The curriculum types resource is a child of the curriculum build statuses resource and lists all the curriculum types that can use this curriculum build status.",
    "items":{
        "$ref":"#/components/schemas/curriculumBuildStatuses-curriculumTypes-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 : curriculumBuildStatuses-curriculumTypes-item-response

Type: object

Show Source

• CurriculumType: string
  Title: Curriculum Type

  Read Only: true

  Maximum Length: 30

  The name of a curriculum type for which a curriculum build status code is valid.
• CurriculumTypeBuildStatusId: integer (int64)
  Title: Curriculum Type Build Status ID

  The unique identifier for the combination of curriculum type and build status, used to filter curriculum build statuses by curriculum type.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type ID

  The unique identifier for a curriculum type, such as program, that's attached to a curriculum build status.
• CurriculumTypeName: string
  Title: Curriculum Type Name

  Read Only: true

  Maximum Length: 50

  The name of a curriculum type such as program or course.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CurriculumTypeBuildStatusId":{
            "title":"Curriculum Type Build Status ID",
            "type":"integer",
            "description":"The unique identifier for the combination of curriculum type and build status, used to filter curriculum build statuses by curriculum type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum type, such as program, that's attached to a curriculum build status.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumTypeName":{
            "title":"Curriculum Type Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a curriculum type such as program or course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Type",
            "maxLength":"30",
            "type":"string",
            "description":"The name of a curriculum type for which a curriculum build status code is valid.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Links

curriculumTypes

Operation: /fscmRestApi/resources/11.13.18.05/curriculumBuildStatuses/{CurriculumBuildStatusId}/child/curriculumTypes

Parameters:

• CurriculumBuildStatusId: $request.path.CurriculumBuildStatusId

The curriculum types resource is a child of the curriculum build statuses resource and lists all the curriculum types that can use this curriculum build status.

herLookupsSystemStatusCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HER_SYSTEM_STATUS_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: SystemStatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top