Jump to

• Request
• Response

Update a business unit assignment

patch

/fscmRestApi/resources/11.13.18.05/businessUnitAssignments/{BusinessUnitAssignmentId}

Request

Path Parameters

• BusinessUnitAssignmentId(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

• AssignmentMethodTypeCode: string
  Title: Assignment Method Type Code

  Maximum Length: 30

  Default Value: ORA_DIRECT

  The method type of the assignment.
• BusinessUnitAssignmentId: integer (int64)
  Title: Settings Assignment ID

  Unique identifier of the academic business unit settings assignment.
• BusinessUnitId: integer
  Title: Business Unit ID

  The unique identifier of the academic business unit.
• RelatedObjectId: integer (int64)
  Title: Related Entity ID

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

  Maximum Length: 30

  The entity type code of the related entity.

{
    "type":"object",
    "properties":{
        "RelatedObjectTypeCode":{
            "title":"Related Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the related entity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelatedObjectId":{
            "title":"Related Entity ID",
            "type":"integer",
            "description":"The unique identifier of the related entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BusinessUnitAssignmentId":{
            "title":"Settings Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the academic business unit settings assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AssignmentMethodTypeCode":{
            "title":"Assignment Method Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The method type of the assignment.",
            "nullable":false,
            "default":"ORA_DIRECT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the academic business unit.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssignedSettingsObjectId",
                    "EntityObjectId",
                    "EntityTypeCode",
                    "RelatedObjectId",
                    "RelatedObjectTypeCode"
                ]
            }
        }
    }
}

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

Type: object

Show Source

• AcademicBusinessUnitName: string
  Title: Academic Business Unit Name

  Read Only: true

  Maximum Length: 255

  The name of the academic business unit.
• AssignmentMethodTypeCode: string
  Title: Assignment Method Type Code

  Maximum Length: 30

  Default Value: ORA_DIRECT

  The method type of the assignment.
• AssignmentMethodTypeMeaning: string
  Title: Assignment Method Type Name

  Read Only: true

  Maximum Length: 80

  The meaning of the assignment method type.
• BusinessUnitAssignmentId: integer (int64)
  Title: Settings Assignment ID

  Unique identifier of the academic business unit settings assignment.
• BusinessUnitId: integer
  Title: Business Unit ID

  The unique identifier of the academic business unit.
• Description: string
  Title: Academic Business Unit Description

  Read Only: true

  Maximum Length: 255

  The description of the academic business unit.
• EntityObjectId: integer (int64)
  Title: Entity ID

  The unique identifier of the academic entity.
• EntityObjectName: string
  Title: Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the academic entity.
• EntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  The entity type code of the academic entity.
• EntityTypeMeaning: string
  Title: Entity Type

  Read Only: true

  Maximum Length: 80

  The meaning of the entity type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelatedObjectId: integer (int64)
  Title: Related Entity ID

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

  Maximum Length: 30

  The entity type code of the related entity.
• RelatedObjectTypeMeaning: string
  Title: Related Entity Type Name

  Read Only: true

  Maximum Length: 80

  The name of the related entity.

{
    "type":"object",
    "properties":{
        "EntityObjectId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the academic entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Academic Business Unit Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the academic business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentMethodTypeCode":{
            "title":"Assignment Method Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The method type of the assignment.",
            "nullable":false,
            "default":"ORA_DIRECT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the academic business unit.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssignedSettingsObjectId",
                    "EntityObjectId",
                    "EntityTypeCode",
                    "RelatedObjectId",
                    "RelatedObjectTypeCode"
                ]
            },
            "x-queryable":true
        },
        "AcademicBusinessUnitName":{
            "title":"Academic Business Unit Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the academic business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "EntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the academic entity.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelatedObjectId":{
            "title":"Related Entity ID",
            "type":"integer",
            "description":"The unique identifier of the related entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessUnitAssignmentId":{
            "title":"Settings Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the academic business unit settings assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RelatedObjectTypeMeaning":{
            "title":"Related Entity Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the related entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedObjectTypeCode":{
            "title":"Related Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the related entity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignmentMethodTypeMeaning":{
            "title":"Assignment Method Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the assignment method type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the entity type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityObjectName":{
            "title":"Entity Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the academic entity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "EntityObjectId",
                    "EntityTypeCode"
                ]
            },
            "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

assignmentMethodTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_SETTINGS_ASSIGN_METHOD

The following properties are defined on the LOV link relation:

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

businessUnitsLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurationsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicBusinessUnitName; Target Attribute: AcademicBusinessUnitName
• Display Attribute: AcademicBusinessUnitName

entityTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: LookupTypeFinder

The following properties are defined on the LOV link relation:

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

relatedObjectTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: LookupTypeFinder

The following properties are defined on the LOV link relation:

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

Back to Top