Jump to

• Request
• Response

Update an assignment

patch

/fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments/{SettingsAssignmentId}

Request

Path Parameters

• DropSchemeId(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=
• SettingsAssignmentId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The start date of the entity assignment.
• associatedAssignments: array Drop Scheme Settings Associated Assignments
  Title: Drop Scheme Settings Associated Assignments

  The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.
• RelatedEntityId: integer (int64)
  Title: Related Entity ID

  The unique identifier of the related entity.
• RelatedEntityTypeCode: string
  Title: Related Entity Type Code

  Maximum Length: 30

  The entity type code of the related entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.

{
    "type":"object",
    "properties":{
        "RelatedEntityTypeCode":{
            "title":"Related Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the related entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "RelatedEntityId":{
            "title":"Related Entity ID",
            "type":"integer",
            "description":"The unique identifier of the related entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The end or expiration date of the entity assignment.",
            "format":"date",
            "nullable":false
        },
        "associatedAssignments":{
            "title":"Drop Scheme Settings Associated Assignments",
            "type":"array",
            "description":"The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.",
            "items":{
                "$ref":"#/components/schemas/dropSchemes-assignments-associatedAssignments-item-patch-request"
            }
        }
    }
}

Nested Schema : Drop Scheme Settings Associated Assignments

Type: array

Title: Drop Scheme Settings Associated Assignments

The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.

Show Source

• Array of: object dropSchemes-assignments-associatedAssignments-item-patch-request

{
    "title":"Drop Scheme Settings Associated Assignments",
    "type":"array",
    "description":"The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.",
    "items":{
        "$ref":"#/components/schemas/dropSchemes-assignments-associatedAssignments-item-patch-request"
    }
}

Nested Schema : dropSchemes-assignments-associatedAssignments-item-patch-request

Type: object

Show Source

• AssociatedObjectId: integer (int64)
  Title: Associated Object ID

  The unique identifier of the object. It can be an academic level ID.

{
    "type":"object",
    "properties":{
        "AssociatedObjectId":{
            "title":"Associated Object ID",
            "type":"integer",
            "description":"The unique identifier of the object. It can be an academic level ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

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 : dropSchemes-assignments-item-response

Type: object

Show Source

• AssignedEntityCode: string
  Title: Entity Code

  Read Only: true

  Maximum Length: 100

  The user defined identifier of the associated entity.
• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityName: string
  Title: Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the associated entity.
• AssignedEntityStatusCode: string
  Title: Entity Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the entity. This controls the availability of the entity for assignments to settings.
• AssignedEntityStatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The status of the entity.
• AssignedEntitySubTypeCode: string
  Title: Entity Subtype Code

  Read Only: true

  Maximum Length: 30

  The entity subtype code of the associated entity.
• AssignedEntitySubTypeMeaning: string
  Title: Entity Subtype

  Read Only: true

  Maximum Length: 80

  The entity subtype of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  The type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignedEntityTypeMeaning: string
  Title: Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity.
• AssignedSettingsObjectId: integer (int64)
  Title: Settings Object ID

  The unique identifier of the associated setting.
• AssignedSettingsTypeCode: string
  Title: Settings Type Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_HER_DROP_SCHEME

  The type code of the associated setting.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentMethodMeaning: string
  Title: Assignment Method

  Read Only: true

  Maximum Length: 80

  The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• AssignmentMethodTypeCode: string
  Title: Assignment Method Code

  Maximum Length: 30

  Default Value: ORA_DIRECT

  The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The start date of the entity assignment.
• associatedAssignments: array Drop Scheme Settings Associated Assignments
  Title: Drop Scheme Settings Associated Assignments

  The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date the row was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• RelatedEntityCode: string
  Title: Related Entity Code

  Read Only: true

  Maximum Length: 100

  The user defined identifier of the related entity.
• RelatedEntityId: integer (int64)
  Title: Related Entity ID

  The unique identifier of the related entity.
• RelatedEntityName: string
  Title: Related Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the related entity.
• RelatedEntityTypeCode: string
  Title: Related Entity Type Code

  Maximum Length: 30

  The entity type code of the related entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• RelatedEntityTypeMeaning: string
  Title: Related Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the related entity.
• SettingsAssignmentId: integer (int64)
  Title: Settings Assignment ID

  Read Only: true

  The unique identifier for the setup association record.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SettingsAssignmentId":{
            "title":"Settings Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the setup association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignedEntityCode":{
            "title":"Entity Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntitySubTypeCode":{
            "title":"Entity Subtype Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity subtype code of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedEntityTypeCode":{
            "title":"Related Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the related entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RelatedEntityId":{
            "title":"Related Entity ID",
            "type":"integer",
            "description":"The unique identifier of the related entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignedEntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":"80",
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentMethodMeaning":{
            "title":"Assignment Method",
            "maxLength":"80",
            "type":"string",
            "description":"The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityStatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntitySubTypeMeaning":{
            "title":"Entity Subtype",
            "maxLength":"80",
            "type":"string",
            "description":"The entity subtype of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedSettingsObjectId":{
            "title":"Settings Object ID",
            "type":"integer",
            "description":"The unique identifier of the associated setting.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The end or expiration date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelatedEntityCode":{
            "title":"Related Entity Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user defined identifier of the related entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityName":{
            "title":"Entity Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedEntityTypeMeaning":{
            "title":"Related Entity Type",
            "maxLength":"80",
            "type":"string",
            "description":"The entity type of the related entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentMethodTypeCode":{
            "title":"Assignment Method Code",
            "maxLength":"30",
            "type":"string",
            "description":"The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.",
            "nullable":false,
            "default":"ORA_DIRECT",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignedEntityStatusCode":{
            "title":"Entity Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the entity. This controls the availability of the entity for assignments to settings.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedSettingsTypeCode":{
            "title":"Settings Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type code of the associated setting.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_HER_DROP_SCHEME",
            "x-queryable":true
        },
        "RelatedEntityName":{
            "title":"Related Entity Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the related entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "associatedAssignments":{
            "title":"Drop Scheme Settings Associated Assignments",
            "type":"array",
            "description":"The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.",
            "items":{
                "$ref":"#/components/schemas/dropSchemes-assignments-associatedAssignments-item-response"
            }
        }
    }
}

Nested Schema : Drop Scheme Settings Associated Assignments

Type: array

Title: Drop Scheme Settings Associated Assignments

The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.

Show Source

• Array of: object dropSchemes-assignments-associatedAssignments-item-response

{
    "title":"Drop Scheme Settings Associated Assignments",
    "type":"array",
    "description":"The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.",
    "items":{
        "$ref":"#/components/schemas/dropSchemes-assignments-associatedAssignments-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 : dropSchemes-assignments-associatedAssignments-item-response

Type: object

Show Source

• AssociatedAssignmentId: integer (int64)
  Title: Associated Assignment ID

  Read Only: true

  The unique identifier for the settings associated assignment record.
• AssociatedObjectCode: string
  Title: Academic Level Code

  Read Only: true

  Maximum Length: 100

  The unique code of the object. It can be an academic level code.
• AssociatedObjectId: integer (int64)
  Title: Associated Object ID

  The unique identifier of the object. It can be an academic level ID.
• AssociatedObjectName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of the object. It can be an academic level name.
• AssociatedObjectTypeCode: string
  Title: Associated Object Type Code

  Maximum Length: 30

  Default Value: ORA_HER_ACADEMIC_LEVEL

  The type code of the associated object. A list of accepted values is defined in the lookup type ORA_HEY_SUB_OBJECT_TYPE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssociatedObjectName":{
            "title":"Academic Level Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the object. It can be an academic level name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedObjectId":{
            "title":"Associated Object ID",
            "type":"integer",
            "description":"The unique identifier of the object. It can be an academic level ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssociatedAssignmentId":{
            "title":"Associated Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the settings associated assignment record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssociatedObjectTypeCode":{
            "title":"Associated Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type code of the associated object. A list of accepted values is defined in the lookup type ORA_HEY_SUB_OBJECT_TYPE.",
            "nullable":false,
            "default":"ORA_HER_ACADEMIC_LEVEL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssociatedObjectCode":{
            "title":"Academic Level Code",
            "maxLength":"100",
            "type":"string",
            "description":"The unique code of the object. It can be an academic level code.",
            "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

AssignmentMethodTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{AssignmentMethodTypeCode}%2CLookupType%3DORA_HEY_SETTINGS_ASSIGN_METHOD

The following properties are defined on the LOV link relation:

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

EntityCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicEntities

The following properties are defined on the LOV link relation:

• Source Attribute: AssignedEntityId; Target Attribute: AssociatedEntityId
• Display Attribute: AssociatedEntityName

EntityTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{AssignedEntityTypeCode}%2CLookupType%3DORA_HER_ASSOCIATED_OBJECT_TYPE

The following properties are defined on the LOV link relation:

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

RelatedEntityTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{RelatedEntityTypeCode}%2CLookupType%3DORA_HER_ASSOCIATED_OBJECT_TYPE

The following properties are defined on the LOV link relation:

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

associatedAssignments

Operation: /fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments/{SettingsAssignmentId}/child/associatedAssignments

Parameters:

• DropSchemeId: $request.path.DropSchemeId
• SettingsAssignmentId: $request.path.SettingsAssignmentId

The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.

Back to Top