Update a building
patch
/fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}
Request
Path Parameters
-
BuildingId(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
Root Schema : schema
Type:
Show Source
object
-
assignments: array
Drop Scheme Settings Assignments
Title:
Drop Scheme Settings Assignments
The assignments resource provides a list of academic entities which have been assigned. -
BuildingDescription: string
Maximum Length:
1000
The description of the building. -
BuildingName: string
Maximum Length:
100
The name of the building. -
BuildingStatusCode: string
Maximum Length:
30
Default Value:ORA_ACTIVE
The building status code. A list of accepted values is defined in the lookup type ORA_HER_BUILDING_STATUS_CODE. -
BuildingTimeZoneCode: string
Maximum Length:
50
The time zone of the building. -
contacts: array
Contacts
Title:
Contacts
The contacts resource is used to view all associated contacts. -
locations: array
Locations
Title:
Locations
The locations resource shows all associated locations.
Nested Schema : Drop Scheme Settings Assignments
Type:
array
Title:
Drop Scheme Settings Assignments
The assignments resource provides a list of academic entities which have been assigned.
Show Source
Nested Schema : Contacts
Type:
array
Title:
Contacts
The contacts resource is used to view all associated contacts.
Show Source
Nested Schema : Locations
Type:
array
Title:
Locations
The locations resource shows all associated locations.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AssignmentEndDate: string
(date)
Title:
Assignment End Date
The end or expiration date of the entity assignment. -
AssignmentMethodTypeCode: string
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. -
RelatedEntityId: integer
(int64)
The unique identifier of the related entity.
-
RelatedEntityTypeCode: string
Maximum Length:
30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
Nested Schema : academicBuildings-contacts-item-patch-request
Type:
Show Source
object
-
AssociationEndDate: string
(date)
The end or expiration date of the contact association.
-
AssociationStartDate: string
(date)
The start date of the contact association.
-
ContactPartyId: integer
(int64)
The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person.
-
ContactTypeCode: string
Maximum Length:
30
Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
Department: string
Maximum Length:
100
The name of the department that the contact belongs to. -
JobTitle: string
Maximum Length:
100
The job title of the associated contact. -
PrimaryContactFlag: boolean
Maximum Length:
1
Indicates that this person should be the primary contact.
Nested Schema : schema
Type:
Show Source
object
-
AssociationEndDate: string
(date)
The end date of the location site association.
-
AssociationStartDate: string
(date)
The start date of the location site association.
-
LocationId: integer
(int64)
The unique identifier of the location.
-
PreferredAddressFlag: boolean
Maximum Length:
1
Indicates the preferred address. The default value is: false.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : academicBuildings-item-response
Type:
Show Source
object
-
assignments: array
Drop Scheme Settings Assignments
Title:
Drop Scheme Settings Assignments
The assignments resource provides a list of academic entities which have been assigned. -
BuildingCode: string
Maximum Length:
6
The unique alternate identifier for the building. -
BuildingDescription: string
Maximum Length:
1000
The description of the building. -
BuildingId: integer
(int64)
Read Only:
true
The unique identifier of the building. -
BuildingName: string
Maximum Length:
100
The name of the building. -
BuildingStatus: string
Read Only:
true
Maximum Length:80
The meaning of the building status code. -
BuildingStatusCode: string
Maximum Length:
30
Default Value:ORA_ACTIVE
The building status code. A list of accepted values is defined in the lookup type ORA_HER_BUILDING_STATUS_CODE. -
BuildingTimeZone: string
Title:
Timezone Name
Read Only:true
Maximum Length:80
The name of the time zone. -
BuildingTimeZoneCode: string
Maximum Length:
50
The time zone of the building. -
contacts: array
Contacts
Title:
Contacts
The contacts resource is used to view all associated contacts. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
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. -
locations: array
Locations
Title:
Locations
The locations resource shows all associated locations.
Nested Schema : Drop Scheme Settings Assignments
Type:
array
Title:
Drop Scheme Settings Assignments
The assignments resource provides a list of academic entities which have been assigned.
Show Source
Nested Schema : Contacts
Type:
array
Title:
Contacts
The contacts resource is used to view all associated contacts.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Locations
Type:
array
Title:
Locations
The locations resource shows all associated locations.
Show Source
Nested Schema : academicBuildings-assignments-item-response
Type:
Show Source
object
-
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
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
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
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. -
AssignmentEndDate: string
(date)
Title:
Assignment End Date
The end or expiration date of the entity assignment. -
AssignmentMethodMeaning: string
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
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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
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
Read Only:
true
Maximum Length:100
The user defined identifier of the related entity. -
RelatedEntityId: integer
(int64)
The unique identifier of the related entity.
-
RelatedEntityName: string
Read Only:
true
Maximum Length:100
The name of the related entity. -
RelatedEntityTypeCode: string
Maximum Length:
30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
RelatedEntityTypeMeaning: string
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : academicBuildings-contacts-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date)
The end or expiration date of the contact association.
-
AssociationStartDate: string
(date)
The start date of the contact association.
-
ContactAssociationId: integer
(int64)
Read Only:
true
The unique identifier for the contact association record. -
ContactPartyId: integer
(int64)
The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person.
-
ContactStatusCode: string
Read Only:
true
Maximum Length:30
Default Value:ORA_ACTIVE
The contact status code for this contact. -
ContactStatusMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the contact status code for this contact. -
ContactTypeCode: string
Maximum Length:
30
Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
ContactTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the contact type code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
DefaultContactTypeCode: string
Read Only:
true
Maximum Length:30
The default contact type code for this contact. -
DefaultContactTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the default contact type code for this contact. -
DefaultDepartment: string
Read Only:
true
Maximum Length:100
The default job title for this contact. -
DefaultJobTitle: string
Read Only:
true
Maximum Length:100
The default department of this contact. -
Department: string
Maximum Length:
100
The name of the department that the contact belongs to. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the contact. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the person. -
FullName: string
Title:
Name
Read Only:true
Maximum Length:360
The first and last name of the person displayed as a single string. -
JobTitle: string
Maximum Length:
100
The job title of the associated contact. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the person. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
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. -
MiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The middle name of the person. -
NameSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:30
The name suffix of the person such as junior or senior. -
PhoneAreaCode: string
Read Only:
true
Maximum Length:20
The area code within a country. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
The international country code for a phone number. For example, 33 for France. -
PhoneNumber: string
Read Only:
true
Maximum Length:40
The phone number formatted in the local format. The number should not include area code, country code, or extension. -
PreferredFirstName: string
Read Only:
true
Maximum Length:150
The preferred first name of a person. -
PreferredFullName: string
Read Only:
true
Maximum Length:360
The preferred first and last name of the person displayed as a single string. -
PreferredLastName: string
Read Only:
true
Maximum Length:150
The preferred last name of a person. -
PreferredMiddleName: string
Read Only:
true
Maximum Length:60
The preferred middle name of a person. -
PreferredNameSuffix: string
Read Only:
true
Maximum Length:30
The preferred name suffix of the person such as junior or senior. -
PreferredNameTitle: string
Read Only:
true
Maximum Length:60
The preferred name title of the person such as Mr or Mrs. -
PrimaryContactFlag: boolean
Maximum Length:
1
Indicates that this person should be the primary contact. -
Title: string
Title:
Title
Read Only:true
Maximum Length:60
The name title or prefix of the person such as Mr or Mrs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicBuildings-locations-item-response
Type:
Show Source
object
-
AddrElementAttributeFive: string
Title:
Additional Address Element 5
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeFour: string
Title:
Additional Address Element 4
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeOne: string
Title:
Additional Address Element 1
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeThree: string
Title:
Additional Address Element 3
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeTwo: string
Title:
Additional Address Element 2
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddressFour: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
The fourth line for the address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Read Only:true
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines, used in Japan. -
AddressOne: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
The first line for the address. -
AddressThree: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
The third line for the address. -
AddressTwo: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
The second line for the address. -
AddressUseTypeCode: string
Read Only:
true
Maximum Length:30
The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE. -
AddressUseTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The meaning of the site use type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE. -
AssociationEndDate: string
(date)
The end date of the location site association.
-
AssociationStartDate: string
(date)
The start date of the location site association.
-
Building: string
Title:
Building
Read Only:true
Maximum Length:240
The building name or number at a given address. -
City: string
Title:
City
Read Only:true
Maximum Length:60
The city for the address. -
CountryCode: string
Title:
Country
Read Only:true
Maximum Length:2
The country code from the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Read Only:true
Maximum Length:60
The county of the address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
FloorNumber: string
Title:
Floor
Read Only:true
Maximum Length:40
The floor number at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The address formatted based on the country code. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The multiline display for the formatted address. -
HouseType: string
Title:
House Type
Read Only:true
Maximum Length:30
The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
HouseTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
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. -
LocationAssociationId: integer
(int64)
The unique identifier for the location association identifier.
-
LocationDirections: string
Title:
Location Directions
Read Only:true
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
The unique identifier of the location.
-
LocationName: string
Title:
Location Name
Read Only:true
Maximum Length:100
The name of the location. -
LocationStatusCode: string
Read Only:
true
Maximum Length:30
The status code of the location. This controls the availability of the location for assignments. -
LocationStatusMeaning: string
Read Only:
true
Maximum Length:80
The status of the location. -
Position: string
Title:
Position
Read Only:true
Maximum Length:50
The primary direction such as North or East that's used to access the location. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
The postal code for the address. -
PostalPlusFourCode: string
Title:
Postal Code Extension
Read Only:true
Maximum Length:20
The four digit extension to the United States postal code. -
PreferredAddressFlag: boolean
Maximum Length:
1
Indicates the preferred address. The default value is: false. -
Province: string
Title:
Province
Read Only:true
Maximum Length:60
The province of the address. -
StateCode: string
Title:
State
Read Only:true
Maximum Length:60
The state of the address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- assignments
-
Parameters:
- BuildingId:
$request.path.BuildingId
The assignments resource provides a list of academic entities which have been assigned. - BuildingId:
- buildingStatusLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{BuildingStatusCode}%2CLookupType%3DORA_HER_BUILDING_STATUS_CODE
The following properties are defined on the LOV link relation:- Source Attribute: BuildingStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- contacts
-
Parameters:
- BuildingId:
$request.path.BuildingId
The contacts resource is used to view all associated contacts. - BuildingId:
- locations
-
Parameters:
- BuildingId:
$request.path.BuildingId
The locations resource shows all associated locations. - BuildingId: