Jump to

• Request
• Response

Update a service profile

patch

/crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}

Request

Path Parameters

• ServiceProfileNumber(required): string
  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

• BillToCustomerAccountId: integer (int64)
  Title: Bill-to Customer Account ID

  The customer account to be billed for work performed for the service profile.
• BillToCustomerAccountNumber: string
  Title: Bill-to Customer Account Number

  Maximum Length: 30

  The PUID for the customer account to be billed for work performed for the service profile.
• BillToCustomerAccountSiteId: integer (int64)
  Title: Bill-to Customer Account Site ID

  The customer account site to be billed for work performed for the service profile.
• BillToCustomerId: integer (int64)
  Title: Bill-to Customer ID

  The customer to be billed for work performed for the service profile.
• BillToPartySiteId: integer (int64)
  Title: Bill-To Party Site ID

  The party site to be billed for work performed for the service profile.
• contacts: array Service Profile Contacts
  Title: Service Profile Contacts

  The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.
• CustomerPartyType: string
  Title: Customer Party Type

  Maximum Length: 30

  Indicates whether the service profile customer is a person or organization.
• notes: array Notes
  Title: Notes

  The note objects resource is used to view the note objects.
• PrimaryContactPartyId: integer (int64)
  Title: Primary Contact Party ID

  The primary contact of the service profile.
• ServiceProfileName: string
  Title: Service Profile Name

  Maximum Length: 400

  The name of the service profile.
• StatusCd: string
  Title: Status Code

  Maximum Length: 30

  Default Value: ORA_SVC_ACTIVE

  Indicates whether the service profile is active.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  Default Value: ORA_SVC_CRM

  Indicates the type of service implementation for the service profile. For example, CRM or Internal Help Desk service profile.
• TypeCd: string
  Title: Type CD

  Maximum Length: 30

  Default Value: ORA_SVC_SITE

  The type of service profile.

{
    "type":"object",
    "properties":{
        "BillToCustomerId":{
            "title":"Bill-to Customer ID",
            "type":"integer",
            "description":"The customer to be billed for work performed for the service profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillToPartySiteId":{
            "title":"Bill-To Party Site ID",
            "type":"integer",
            "description":"The party site to be billed for work performed for the service profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The note objects resource is used to view the note objects.",
            "items":{
                "$ref":"#/components/schemas/serviceProfiles-notes-item-patch-request"
            }
        },
        "BillToCustomerAccountSiteId":{
            "title":"Bill-to Customer Account Site ID",
            "type":"integer",
            "description":"The customer account site to be billed for work performed for the service profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the service profile is active.",
            "nullable":false,
            "default":"ORA_SVC_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TypeCd":{
            "title":"Type CD",
            "maxLength":"30",
            "type":"string",
            "description":"The type of service profile.",
            "nullable":false,
            "default":"ORA_SVC_SITE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerPartyType":{
            "title":"Customer Party Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the service profile customer is a person or organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of service implementation for the service profile. For example, CRM or Internal Help Desk service profile.",
            "nullable":false,
            "default":"ORA_SVC_CRM",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact Party ID",
            "type":"integer",
            "description":"The primary contact of the service profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillToCustomerAccountNumber":{
            "title":"Bill-to Customer Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The PUID for the customer account to be billed for work performed for the service profile.",
            "nullable":false
        },
        "contacts":{
            "title":"Service Profile Contacts",
            "type":"array",
            "description":"The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.",
            "items":{
                "$ref":"#/components/schemas/serviceProfiles-contacts-item-patch-request"
            }
        },
        "ServiceProfileName":{
            "title":"Service Profile Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the service profile.",
            "nullable":false
        },
        "BillToCustomerAccountId":{
            "title":"Bill-to Customer Account ID",
            "type":"integer",
            "description":"The customer account to be billed for work performed for the service profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Service Profile Contacts

Type: array

Title: Service Profile Contacts

The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.

Show Source

• Array of: object schema

{
    "title":"Service Profile Contacts",
    "type":"array",
    "description":"The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.",
    "items":{
        "$ref":"#/components/schemas/serviceProfiles-contacts-item-patch-request"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The note objects resource is used to view the note objects.

Show Source

• Array of: object schema

{
    "title":"Notes",
    "type":"array",
    "description":"The note objects resource is used to view the note objects.",
    "items":{
        "$ref":"#/components/schemas/serviceProfiles-notes-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• PrimaryContactFlag: boolean
  Title: Primary

  Indicates the contact is the primary contact for the service profile.

{
    "type":"object",
    "properties":{
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates the contact is the primary contact for the service profile.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code for extensibility.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the party.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for extensibility.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code for extensibility.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  The column which stores the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The note type code for categorization of note.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the parent source object associated to the note.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the parent source object associated to the note.",
            "nullable":false
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The note type code for categorization of note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The column which stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":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 : serviceProfiles-item-response

Type: object

Show Source

• BillToAccountSiteFormattedAddress: string
  Title: Bill-to Account Site Formatted Address

  Read Only: true

  Maximum Length: 1000

  The formatted address to be billed for work performed for the service profile.
• BillToCustomerAccountDescription: string
  Title: Bill-to Customer Account Description

  Read Only: true

  Maximum Length: 240

  The description of the customer account to be billed for work performed for the service profile.
• BillToCustomerAccountId: integer (int64)
  Title: Bill-to Customer Account ID

  The customer account to be billed for work performed for the service profile.
• BillToCustomerAccountNumber: string
  Title: Bill-to Customer Account Number

  Maximum Length: 30

  The PUID for the customer account to be billed for work performed for the service profile.
• BillToCustomerAccountSiteId: integer (int64)
  Title: Bill-to Customer Account Site ID

  The customer account site to be billed for work performed for the service profile.
• BillToCustomerId: integer (int64)
  Title: Bill-to Customer ID

  The customer to be billed for work performed for the service profile.
• BillToCustomerPartyName: string
  Title: Bill-to Customer Party Name

  Read Only: true

  Maximum Length: 360

  The name of the customer to be billed for work performed for the service profile.
• BillToCustomerPartyNumber: string
  Title: Bill-to Customer Registry Number

  Read Only: true

  Maximum Length: 30

  The PUID for the customer to be billed for work performed for the service profile.
• BillToCustomerPartyUniqueName: string
  Title: Bill-to Customer Party Unique Name

  Read Only: true

  Maximum Length: 900

  The unique name of the customer to be billed for work performed for the service profile.
• BillToPartySiteId: integer (int64)
  Title: Bill-To Party Site ID

  The party site to be billed for work performed for the service profile.
• BillToPartySiteName: string
  Title: Bill-to Party Site Name

  Read Only: true

  Maximum Length: 240

  The name given to the party site that will be billed for work performed for the service profile.
• BillToPartySiteNumber: string
  Title: Bill-to Party Site Number

  Read Only: true

  Maximum Length: 30

  The PUID for the party site that will be billed for work performed for the service profile.
• contacts: array Service Profile Contacts
  Title: Service Profile Contacts

  The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the service profile was created.
• CustomerPartyId: integer (int64)
  Title: Customer Party ID

  The customer having the service profile.
• CustomerPartyName: string
  Title: Customer Name

  Read Only: true

  Maximum Length: 360

  The name of the service profile customer.
• CustomerPartyNumber: string
  Title: Customer Registry Number

  Read Only: true

  Maximum Length: 30

  The PUID for the customer party of the service profile.
• CustomerPartyType: string
  Title: Customer Party Type

  Maximum Length: 30

  Indicates whether the service profile customer is a person or organization.
• CustomerPartyUniqueName: string
  Title: Customer Unique Name

  Read Only: true

  Maximum Length: 900

  The unique name of the service profile customer.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the service profile was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the service profile.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the service profile.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• notes: array Notes
  Title: Notes

  The note objects resource is used to view the note objects.
• PartySiteAddress1: string
  Title: Address1

  Read Only: true

  Maximum Length: 240

  The first address line for the service profile site address.
• PartySiteAddress2: string
  Title: Address2

  Read Only: true

  Maximum Length: 240

  The second address line for the service profile site address.
• PartySiteAddress3: string
  Title: Address3

  Read Only: true

  Maximum Length: 240

  The third address line for the service profile site address.
• PartySiteAddress4: string
  Title: Address4

  Read Only: true

  Maximum Length: 240

  The fourth address line for the service profile site address.
• PartySiteBuilding: string
  Title: Building

  Read Only: true

  Maximum Length: 240

  The building information for the service profile site address.
• PartySiteCity: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city for the service profile site address.
• PartySiteCountry: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  The country for the service profile site address.
• PartySiteCounty: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county for the service profile site address.
• PartySiteFloorNumber: string
  Title: Floor Number

  Read Only: true

  Maximum Length: 40

  The floor in the building for the service profile site address.
• PartySiteFormattedAddress: string
  Title: Party Site Formatted Address

  Read Only: true

  Maximum Length: 1000

  The formatted site address of the service profile.
• PartySiteId: integer (int64)
  Title: Party Site ID

  The site address of the service profile.
• PartySiteLatitude: number
  Title: Latitude

  Read Only: true

  The latitude coordinate for the service profile site address.
• PartySiteLocationId: integer (int64)
  Title: Site Location ID

  Read Only: true

  The location identifier for the service profile site address.
• PartySiteLongitude: number
  Title: Longitude

  Read Only: true

  The longitude coordinate for the service profile site address.
• PartySiteName: string
  Title: Site Name

  Read Only: true

  Maximum Length: 240

  The name given to the service profile site address.
• PartySiteNumber: string
  Title: Site Number

  Read Only: true

  Maximum Length: 30

  The PUID of the service profile site address.
• PartySitePartyId: integer (int64)
  Title: Site Party ID

  Read Only: true

  The party of the service profile site address.
• PartySitePartyName: string
  Title: Site Party Name

  Read Only: true

  Maximum Length: 360

  The name of the party of the service profile site address.
• PartySitePartyUniqueName: string
  Title: Site Party Unique Name

  Read Only: true

  Maximum Length: 900

  The unique name of the part of the service profile site address.
• PartySitePostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code for the service profile site address.
• PartySiteProvince: string
  Title: Province

  Read Only: true

  Maximum Length: 60

  The province for the service profile site address.
• PartySiteState: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state for the service profile site address.
• PartySiteTimezoneCode: string
  Title: Time Zone Code

  Read Only: true

  Maximum Length: 64

  The time zone for the service profile site address.
• PartySiteUse: string
  Title: Address Type

  Read Only: true

  Maximum Length: 750

  The type of address stored for the service profile site address.
• PrimaryContactPartyId: integer (int64)
  Title: Primary Contact Party ID

  The primary contact of the service profile.
• PrimaryContactPartyName: string
  Title: Primary Contact Name

  Read Only: true

  Maximum Length: 360

  The name of the service profile primary contact.
• PrimaryContactPartyNumber: string
  Title: Primary Contact Party Number

  Read Only: true

  Maximum Length: 30

  The party number of the service profile primary contact.
• ServiceProfileId: integer (int64)
  Title: Service Profile ID

  Read Only: true

  The unique identifier of the service profile.
• ServiceProfileName: string
  Title: Service Profile Name

  Maximum Length: 400

  The name of the service profile.
• ServiceProfileNumber: string
  Title: Service Profile Number

  Maximum Length: 30

  The PUID of the service profile.
• StatusCd: string
  Title: Status Code

  Maximum Length: 30

  Default Value: ORA_SVC_ACTIVE

  Indicates whether the service profile is active.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  Default Value: ORA_SVC_CRM

  Indicates the type of service implementation for the service profile. For example, CRM or Internal Help Desk service profile.
• TypeCd: string
  Title: Type CD

  Maximum Length: 30

  Default Value: ORA_SVC_SITE

  The type of service profile.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the service profile was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteState":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The note objects resource is used to view the note objects.",
            "items":{
                "$ref":"#/components/schemas/serviceProfiles-notes-item-response"
            }
        },
        "PartySiteLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude coordinate for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerPartyId":{
            "title":"Customer Party ID",
            "type":"integer",
            "description":"The customer having the service profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartySiteTimezoneCode":{
            "title":"Time Zone Code",
            "maxLength":"64",
            "type":"string",
            "description":"The time zone for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerPartyNumber":{
            "title":"Customer Registry Number",
            "maxLength":"30",
            "type":"string",
            "description":"The PUID for the customer party of the service profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToCustomerAccountDescription":{
            "title":"Bill-to Customer Account Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the customer account to be billed for work performed for the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name given to the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The site address of the service profile.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact Party ID",
            "type":"integer",
            "description":"The primary contact of the service profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillToCustomerPartyNumber":{
            "title":"Bill-to Customer Registry Number",
            "maxLength":"30",
            "type":"string",
            "description":"The PUID for the customer to be billed for work performed for the service profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the service profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteFloorNumber":{
            "title":"Floor Number",
            "maxLength":"40",
            "type":"string",
            "description":"The floor in the building for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the service profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteCounty":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "PartySiteUse":{
            "title":"Address Type",
            "maxLength":"750",
            "type":"string",
            "description":"The type of address stored for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BillToAccountSiteFormattedAddress":{
            "title":"Bill-to Account Site Formatted Address",
            "maxLength":"1000",
            "type":"string",
            "description":"The formatted address to be billed for work performed for the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the service profile primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteLocationId":{
            "title":"Site Location ID",
            "type":"integer",
            "description":"The location identifier for the service profile site address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerPartyName":{
            "title":"Customer Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the service profile customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteBuilding":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building information for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude coordinate for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToCustomerAccountId":{
            "title":"Bill-to Customer Account ID",
            "type":"integer",
            "description":"The customer account to be billed for work performed for the service profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillToCustomerId":{
            "title":"Bill-to Customer ID",
            "type":"integer",
            "description":"The customer to be billed for work performed for the service profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartySiteNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"The PUID of the service profile site address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteFormattedAddress":{
            "title":"Party Site Formatted Address",
            "maxLength":"1000",
            "type":"string",
            "description":"The formatted site address of the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySitePartyId":{
            "title":"Site Party ID",
            "type":"integer",
            "description":"The party of the service profile site address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the service profile primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToPartySiteNumber":{
            "title":"Bill-to Party Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"The PUID for the party site that will be billed for work performed for the service profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteProvince":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "BillToCustomerPartyName":{
            "title":"Bill-to Customer Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the customer to be billed for work performed for the service profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceProfileId":{
            "title":"Service Profile ID",
            "type":"integer",
            "description":"The unique identifier of the service profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillToCustomerAccountNumber":{
            "title":"Bill-to Customer Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The PUID for the customer account to be billed for work performed for the service profile.",
            "nullable":false,
            "x-queryable":true
        },
        "ServiceProfileName":{
            "title":"Service Profile Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the service profile.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerPartyUniqueName":{
            "title":"Customer Unique Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the service profile customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToPartySiteId":{
            "title":"Bill-To Party Site ID",
            "type":"integer",
            "description":"The party site to be billed for work performed for the service profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillToCustomerAccountSiteId":{
            "title":"Bill-to Customer Account Site ID",
            "type":"integer",
            "description":"The customer account site to be billed for work performed for the service profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillToCustomerPartyUniqueName":{
            "title":"Bill-to Customer Party Unique Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the customer to be billed for work performed for the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the service profile is active.",
            "nullable":false,
            "default":"ORA_SVC_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartySiteCountry":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country for the service profile site address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteAddress1":{
            "title":"Address1",
            "maxLength":"240",
            "type":"string",
            "description":"The first address line for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PartySiteAddress2":{
            "title":"Address2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PartySiteAddress3":{
            "title":"Address3",
            "maxLength":"240",
            "type":"string",
            "description":"The third address line for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PartySiteAddress4":{
            "title":"Address4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PartySitePostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "TypeCd":{
            "title":"Type CD",
            "maxLength":"30",
            "type":"string",
            "description":"The type of service profile.",
            "nullable":false,
            "default":"ORA_SVC_SITE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartySitePartyName":{
            "title":"Site Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party of the service profile site address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city for the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "CustomerPartyType":{
            "title":"Customer Party Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the service profile customer is a person or organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartySitePartyUniqueName":{
            "title":"Site Party Unique Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the part of the service profile site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of service implementation for the service profile. For example, CRM or Internal Help Desk service profile.",
            "nullable":false,
            "default":"ORA_SVC_CRM",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillToPartySiteName":{
            "title":"Bill-to Party Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name given to the party site that will be billed for work performed for the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceProfileNumber":{
            "title":"Service Profile Number",
            "maxLength":"30",
            "type":"string",
            "description":"The PUID of the service profile.",
            "nullable":false,
            "x-queryable":true
        },
        "contacts":{
            "title":"Service Profile Contacts",
            "type":"array",
            "description":"The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.",
            "items":{
                "$ref":"#/components/schemas/serviceProfiles-contacts-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the service profile was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Service Profile Contacts

Type: array

Title: Service Profile Contacts

The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.

Show Source

• Array of: object serviceProfiles-contacts-item-response

{
    "title":"Service Profile Contacts",
    "type":"array",
    "description":"The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.",
    "items":{
        "$ref":"#/components/schemas/serviceProfiles-contacts-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 : Notes

Type: array

Title: Notes

The note objects resource is used to view the note objects.

Show Source

• Array of: object serviceProfiles-notes-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The note objects resource is used to view the note objects.",
    "items":{
        "$ref":"#/components/schemas/serviceProfiles-notes-item-response"
    }
}

Nested Schema : serviceProfiles-contacts-item-response

Type: object

Show Source

• ContactEmailAddress: string
  Title: Contact Email Address

  Read Only: true

  Maximum Length: 320

  The email address of the contact belonging to the service profile.
• ContactFormattedPhoneNumber: string
  Title: Phone Number

  Read Only: true

  The phone number of the contact belonging to the service profile.
• ContactPartyName: string
  Title: Contact Name

  Read Only: true

  Maximum Length: 360

  The name of the contact belonging to the service profile.
• ContactPartyNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The PUID of the contact belonging to the service profile.
• ContactPartyUniqueName: string
  Title: Contact Unique Name

  Read Only: true

  Maximum Length: 900

  The unique name of the contact belonging to the service profile.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user that created the service profile contact.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the service profile contact was created.
• JobTitle: string
  Title: Job Title

  Read Only: true

  Maximum Length: 100

  The job title of the contact belonging to the service profile.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the service profile contact was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the service profile contact.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the service profile contact.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  The contact for the service profile contact.
• PrimaryContactFlag: boolean
  Title: Primary

  Indicates the contact is the primary contact for the service profile.
• ServiceProfileId: integer (int64)
  Title: Service Profile ID

  The service profile for the service profile contact.
• ServiceProfileName: string
  Title: Service Profile Name

  Read Only: true

  Maximum Length: 400

  The name of the service profile for the service profile contact.
• ServiceProfileNumber: string
  Title: Service Profile Number

  Maximum Length: 30

  The PUID of the service profile for the service profile contact.
• SpContactId: integer (int64)
  Title: Service Profile Contact ID

  Read Only: true

  The unique identifier of the service profile contact.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the service profile contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the service profile contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactFormattedPhoneNumber":{
            "title":"Phone Number",
            "type":"string",
            "description":"The phone number of the contact belonging to the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates the contact is the primary contact for the service profile.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the service profile contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SpContactId":{
            "title":"Service Profile Contact ID",
            "type":"integer",
            "description":"The unique identifier of the service profile contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the contact belonging to the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Contact Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the contact belonging to the service profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyUniqueName":{
            "title":"Contact Unique Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the contact belonging to the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The PUID of the contact belonging to the service profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Contact Email Address",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the contact belonging to the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The contact for the service profile contact.",
            "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"
            }
        },
        "ServiceProfileNumber":{
            "title":"Service Profile Number",
            "maxLength":"30",
            "type":"string",
            "description":"The PUID of the service profile for the service profile contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ServiceProfileId":{
            "title":"Service Profile ID",
            "type":"integer",
            "description":"The service profile for the service profile contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the service profile contact was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the service profile contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceProfileName":{
            "title":"Service Profile Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the service profile for the service profile contact.",
            "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."
        }
    }
}

Nested Schema : serviceProfiles-notes-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code for extensibility.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the party.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for extensibility.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code for extensibility.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the user has access to delete the note.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The email address of the user who created the note.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  The address of the user who created the note.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  The phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The unique identifier of the note. This is the primary key of the notes table.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  The unique identifier of the note. This is the primary key of the notes table.
• NoteNumber: string
  Maximum Length: 30

  The alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  The column which stores the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The note type code for categorization of note.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  The unique identifier of the note. This is the primary key of the notes table.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier of the party.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of the party.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  This is the source object code for the source object as defined in OBJECTS Metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the parent source object associated to the note.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the user can update the note.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"This is the source object code for the source object as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The column which stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the note. This is the primary key of the notes table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The note type code for categorization of note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the parent source object associated to the note.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the note. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "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"
    }
}

Links

CustomerPartyTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CUSTOMER_PARTY_TYPE

The following properties are defined on the LOV link relation:

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

StatusCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SPROF_STATUS_CD

The following properties are defined on the LOV link relation:

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

StripeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

The following properties are defined on the LOV link relation:

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

TypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SPROF_TYPE_CD

The following properties are defined on the LOV link relation:

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

contacts

Operation: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/contacts

Parameters:

• ServiceProfileNumber: $request.path.ServiceProfileNumber

The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.

notes

Operation: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/notes

Parameters:

• ServiceProfileNumber: $request.path.ServiceProfileNumber

The note objects resource is used to view the note objects.

Back to Top