REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Get a business unit

get

/crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}

Request

Path Parameters

crmBusinessUnitsUniqID(required): string

This is the hash key of the attributes which make up the composite key for the CRM Business Units resource and used to uniquely identify an instance of CRM Business Units. The client should not generate the hash key value. Instead, the client should query on the CRM Business Units collection resource in order to navigate to a specific instance of CRM Business Units to get the hash key.

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
links: string

This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

Example:
self,canonical
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

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.

Root Schema : crmBusinessUnits-item-response

Type: object

Show Source

assessmentTemplates: array Assessment Templates

Title: Assessment Templates

The assesment templates resource is used to view the assesment templates. It stores the templates associated with assessments.
BUId: integer

Read Only: true

The unique identifier of a business unit.
BUName: string

Read Only: true

The name of the business unit.
BusinessUnitId: integer

Read Only: true

The unique identifier of a business unit.
DefaultBUFlag: boolean

Read Only: true

Indicates whether the current business unit is logged in user's default business unit. It has the value true and false.
fndCommonSetIdLookups: array Common Set Id Lookups

Title: Common Set Id Lookups

The common set id lookups resource is used to view lookup values for set id enabled lookup types.
links: array Links

Title: Links

The link relations associated with the resource instance.
Name: string

Read Only: true

The name of the business unit.
optyStatus: array Opportunity Status Values

Title: Opportunity Status Values

The opportunity status values resource is used to view the opportunity status value. The configurable setup data is defined specifically for sales usage.
salesMethods: array Sales Methods

Title: Sales Methods

The sales methods resource is used to view an approach which is used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, or closing opportunities.

{
    "type":"object",
    "properties":{
        "BUId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "dependencies":[
                    "BuId"
                ]
            },
            "x-queryable":true
        },
        "salesMethods":{
            "title":"Sales Methods",
            "type":"array",
            "description":"The sales methods resource is used to view an approach which is used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, or closing opportunities.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-item-response"
            }
        },
        "assessmentTemplates":{
            "title":"Assessment Templates",
            "type":"array",
            "description":"The assesment templates resource is used to view the assesment templates. It stores the templates associated with assessments.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-assessmentTemplates-item-response"
            }
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "dependencies":[
                    "BuId"
                ]
            },
            "x-queryable":true
        },
        "fndCommonSetIdLookups":{
            "title":"Common Set Id Lookups",
            "type":"array",
            "description":"The common set id lookups resource is used to view lookup values for set id enabled lookup types.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-fndCommonSetIdLookups-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BUName":{
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "dependencies":[
                    "BuName"
                ]
            },
            "x-queryable":true
        },
        "optyStatus":{
            "title":"Opportunity Status Values",
            "type":"array",
            "description":"The opportunity status values resource is used to view the opportunity status value. The configurable setup data is defined specifically for sales usage.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-optyStatus-item-response"
            }
        },
        "DefaultBUFlag":{
            "type":"boolean",
            "description":"Indicates whether the current business unit is logged in user's default business unit. It has the value true and false.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "dependencies":[
                    "BuId"
                ]
            },
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "dependencies":[
                    "BuName"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Assessment Templates

Type: array

Title: Assessment Templates

The assesment templates resource is used to view the assesment templates. It stores the templates associated with assessments.

Show Source

Array of: object crmBusinessUnits-assessmentTemplates-item-response

{
    "title":"Assessment Templates",
    "type":"array",
    "description":"The assesment templates resource is used to view the assesment templates. It stores the templates associated with assessments.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-assessmentTemplates-item-response"
    }
}

Nested Schema : Common Set Id Lookups

Type: array

Title: Common Set Id Lookups

The common set id lookups resource is used to view lookup values for set id enabled lookup types.

Show Source

Array of: object crmBusinessUnits-fndCommonSetIdLookups-item-response

{
    "title":"Common Set Id Lookups",
    "type":"array",
    "description":"The common set id lookups resource is used to view lookup values for set id enabled lookup types.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-fndCommonSetIdLookups-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 : Opportunity Status Values

Type: array

Title: Opportunity Status Values

The opportunity status values resource is used to view the opportunity status value. The configurable setup data is defined specifically for sales usage.

Show Source

Array of: object crmBusinessUnits-optyStatus-item-response

{
    "title":"Opportunity Status Values",
    "type":"array",
    "description":"The opportunity status values resource is used to view the opportunity status value. The configurable setup data is defined specifically for sales usage.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-optyStatus-item-response"
    }
}

Nested Schema : Sales Methods

Type: array

Title: Sales Methods

The sales methods resource is used to view an approach which is used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, or closing opportunities.

Show Source

Array of: object crmBusinessUnits-salesMethods-item-response

{
    "title":"Sales Methods",
    "type":"array",
    "description":"The sales methods resource is used to view an approach which is used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, or closing opportunities.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-item-response"
    }
}

Nested Schema : crmBusinessUnits-assessmentTemplates-item-response

Type: object

Show Source

AssessedObjTypeCode: string

Maximum Length: 50

The code indicating the type of the assessed business object.
AssessTemplateId: integer (int64)

The unique identifier of the assessment template that served as the source of this assessment.
links: array Links

Title: Links

The link relations associated with the resource instance.
Name: string

Title: Name

Maximum Length: 100

The name of the assessment template.
ObjectVersionNumber: integer (int32)

The number used to implement locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssessedObjTypeCode":{
            "maxLength":"50",
            "type":"string",
            "description":"The code indicating the type of the assessed business object.",
            "nullable":false,
            "x-queryable":false
        },
        "AssessTemplateId":{
            "type":"integer",
            "description":"The unique identifier of the assessment template that served as the source of this assessment.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the assessment template.",
            "nullable":false,
            "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 : crmBusinessUnits-fndCommonSetIdLookups-item-response

Type: object

Show Source

BUId: integer

Read Only: true

The unique identifier of a business unit.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Read Only: true

The date and time when the record was created.
Description: string

Title: Description

Read Only: true

Maximum Length: 240

The description of the lookup type.
DisplaySequence: integer (int64)

Read Only: true

The number denoting the place where the lookup type will be displayed in the list sequence.
EndDateActive: string (date)

Read Only: true

The date when the lookup type will become inactive.
LastUpdateDate: string (date-time)

Read Only: true

The date and time when the record was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

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.
LookupCode: string

Title: Lookup Code

Read Only: true

Maximum Length: 30

The code used to identify the lookup.
LookupType: string

Title: Lookup Type

Read Only: true

Maximum Length: 30

The lookup type associated with the lookup value.
Meaning: string

Title: Meaning

Read Only: true

Maximum Length: 80

The meaning of the lookup type.
SetId: integer (int64)

Title: Set Id

Read Only: true

The identifier for lookup value's reference data set.
StartDateActive: string (date)

Read Only: true

The date when the lookup type was enabled.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the lookup type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup type associated with the lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"The number denoting the place where the lookup type will be displayed in the list sequence.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code used to identify the lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "type":"string",
            "description":"The date when the lookup type was enabled.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BUId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "type":"string",
            "description":"The date when the lookup type will become inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SetId":{
            "title":"Set Id",
            "type":"integer",
            "description":"The identifier for lookup value's reference data set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the lookup type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "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"
    }
}

Nested Schema : crmBusinessUnits-optyStatus-item-response

Type: object

Show Source

AppliesToLOVSwitcher: string

Read Only: true

This is used in UI for differentiating between LOVs when picker is displayed.
BUId: integer

Read Only: true

The unique identifier of a business unit.
CategoryLOVSwitcher: string

Read Only: true

This is used in UI for differentiating between LOVs when picker is displayed.
ConflictId: integer (int64)

Default Value: 0

The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Read Only: true

The date and time when the record was created.
Description: string

Title: Description

Maximum Length: 240

The description of the lookup type.
DisplaySequence: integer (int64)

Title: Display Sequence

The order in which the status code is displayed.
EnabledFlag: boolean

Title: Active

Maximum Length: 1

Indicates whether the lookup type is enabled.
EndDateActive: string (date)

The date when the lookup type is disabled.
LastUpdateDate: string (date-time)

Read Only: true

The date and time when the record was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

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.
LookupCategory: string

Title: Status Category

Maximum Length: 30

The lookup category associated with the lookup value.
LookupCode: string

Title: Status Code

Maximum Length: 30

The lookup code associated with the lookup value.
LookupType: string

Title: Status

Maximum Length: 30

Default Value: OPTY_STATUS

The lookup type associated with the lookup value.
LookupValuesId: integer (int64)

The unique identifier of the lookup value.
Meaning: string

Title: Status

Maximum Length: 80

The translated value of the lookup value.
ObjectVersionNumber: integer (int32)

Read Only: true

The object version number implements optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
SetCode: string

Title: Set Code

Read Only: true

Maximum Length: 30

The sales status lookup value's reference data set code.
SetId: integer (int64)

Title: Set

The unique identifier of the sales status lookup value's reference data.
SetIdLOVSwitcher: string

Read Only: true

This is used in UI for differentiating between LOVs when picker is displayed.
SetIdP: integer (int64)

Read Only: true

The unique identifier of the sales status lookup value's reference data.
SetName: string

Title: Set Name

Read Only: true

Maximum Length: 80

The name of the sales status lookup value's reference data set identifier.
StartDateActive: string (date)

The date when the lookup type is made active.
UserLastUpdateDate: string (date-time)

The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as a different mobile database, or the server.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the lookup type.",
            "nullable":true,
            "x-queryable":true
        },
        "LookupValuesId":{
            "type":"integer",
            "description":"The unique identifier of the lookup value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the status code is displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as a different mobile database, or the server.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SetCode":{
            "title":"Set Code",
            "maxLength":"30",
            "type":"string",
            "description":"The sales status lookup value's reference data set code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BUId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "type":"string",
            "description":"The date when the lookup type is made active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SetIdP":{
            "type":"integer",
            "description":"The unique identifier of the sales status lookup value's reference data.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number implements optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LookupCategory":{
            "title":"Status Category",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup category associated with the lookup value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the lookup type is enabled.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryLOVSwitcher":{
            "type":"string",
            "description":"This is used in UI for differentiating between LOVs when picker is displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup type associated with the lookup value.",
            "nullable":false,
            "default":"OPTY_STATUS",
            "x-queryable":true
        },
        "SetName":{
            "title":"Set Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the sales status lookup value's reference data set identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code associated with the lookup value.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDateActive":{
            "type":"string",
            "description":"The date when the lookup type is disabled.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AppliesToLOVSwitcher":{
            "type":"string",
            "description":"This is used in UI for differentiating between LOVs when picker is displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetIdLOVSwitcher":{
            "type":"string",
            "description":"This is used in UI for differentiating between LOVs when picker is displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetId":{
            "title":"Set",
            "type":"integer",
            "description":"The unique identifier of the sales status lookup value's reference data.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Meaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The translated value of the lookup value.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "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"
    }
}

Nested Schema : crmBusinessUnits-salesMethods-item-response

Type: object

Show Source

BUId: integer

Read Only: true

The unique identifier of a business unit.
ConflictId: integer (int64)

Default Value: 0

The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Read Only: true

The date and time when the record was created.
DefaultSalesMethodFlag: boolean

Title: Default Sales Method

Read Only: true

Indicates whether the current sales method is logged in user's default business unit. It has the value true and false.
DefaultSalesMethodForExpansionFlag: boolean

Title: Default Sales Method for Expansion

Read Only: true

The default sales method for an expansion opportunity.
DefaultSalesMethodForRenewalFlag: boolean

Title: Default Sales Method for Renewal

Read Only: true

The default sales method for a renewal opportunity.
DeletedFlag: boolean

Title: Disabled

Maximum Length: 2

Default Value: false

Indicates whether the sales method has been deleted.
DescriptionText: string

Title: Description

Maximum Length: 255

The description of the sales method.
LastUpdateDate: string (date-time)

Read Only: true

The date and time when the record was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

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.
Name: string

Title: Name

Maximum Length: 50

The name of the sales method.
OpportunityType: string

Title: Opportunity Type

Maximum Length: 30

Indicates if the type of opportunity is New, Renewal, or an Expansion.
OptyCloseWindow: integer (int64)

Title: Close Window

The sales method opportunity close window.
RevnLineSetEnabledFlag: boolean

Title: Revenue Line-Set Enabled

Maximum Length: 1

Default Value: false

Indicates whether the revenue line set will be enabled when using this sales method.
SalesMethodId: integer (int64)

The unique identifier of the sales method.
SalesMethodNumber: string

Title: Sales Method Number

Maximum Length: 64

A GUID-based column that has been created to be an alternate key for data migration.
SalesStage: array Sales Stages

Title: Sales Stages

The sales stages resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.
SetIdP: integer (int64)

Read Only: true

The unique identifier of the sales method lookup value's reference data set.
SetName: string

Title: Set

Read Only: true

Maximum Length: 80

The name of the sales method reference data set identifier.
UserLastUpdateDate: string (date-time)

The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as different mobile database, or the server.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DefaultSalesMethodForExpansionFlag":{
            "title":"Default Sales Method for Expansion",
            "type":"boolean",
            "description":"The default sales method for an expansion opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesMethodNumber":{
            "title":"Sales Method Number",
            "maxLength":"64",
            "type":"string",
            "description":"A GUID-based column that has been created to be an alternate key for data migration.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesMethodId":{
            "type":"integer",
            "description":"The unique identifier of the sales method.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SalesStage":{
            "title":"Sales Stages",
            "type":"array",
            "description":"The sales stages resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-item-response"
            }
        },
        "OptyCloseWindow":{
            "title":"Close Window",
            "type":"integer",
            "description":"The sales method opportunity close window.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "DefaultSalesMethodFlag":{
            "title":"Default Sales Method",
            "type":"boolean",
            "description":"Indicates whether the current sales method is logged in user's default business unit. It has the value true and false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RevnLineSetEnabledFlag":{
            "title":"Revenue Line-Set Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the revenue line set will be enabled when using this sales method.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SetName":{
            "title":"Set",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the sales method reference data set identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as different mobile database, or the server.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ConflictId":{
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the sales method.",
            "nullable":true,
            "x-queryable":true
        },
        "BUId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultSalesMethodForRenewalFlag":{
            "title":"Default Sales Method for Renewal",
            "type":"boolean",
            "description":"The default sales method for a renewal opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetIdP":{
            "type":"integer",
            "description":"The unique identifier of the sales method lookup value's reference data set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DeletedFlag":{
            "title":"Disabled",
            "maxLength":"2",
            "type":"boolean",
            "description":"Indicates whether the sales method has been deleted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the sales method.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityType":{
            "title":"Opportunity Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the type of opportunity is New, Renewal, or an Expansion.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : Sales Stages

Type: array

Title: Sales Stages

The sales stages resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.

Show Source

Array of: object crmBusinessUnits-salesMethods-SalesStage-item-response

{
    "title":"Sales Stages",
    "type":"array",
    "description":"The sales stages resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-item-response"
    }
}

Nested Schema : crmBusinessUnits-salesMethods-SalesStage-item-response

Type: object

Show Source

AttachmentEntityName: string

Maximum Length: 255

Default Value: MOO_STG_B

The name of the attachment entity. Default value is MOO_STG_B.
Attachments: array Attachments

Title: Attachments

The attachments resource is used to view, create, and update attachments.
AverageDaysAtStage: integer (int64)

Title: Duration

The average number of days of sales stage.
ConflictId: integer (int64)

Default Value: 0

The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Read Only: true

The date and time when the record was created.
DeletedFlag: boolean

Maximum Length: 2

Default Value: false

Indicates whether the sales stage has been deleted.
DescriptionText: string

Title: Description

Maximum Length: 255

The description of the sales stage.
LastUpdateDate: string (date-time)

Read Only: true

The date and time when the record was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

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.
MaximumDaysInStage: integer (int64)

Title: Stalled Deal Limit

The maximum number of days of a sales stage.
Name: string

Title: Name

Maximum Length: 50

The name of the sales stage.
PhaseCd: string

Title: Phase

Maximum Length: 30

Default Value: "B - Working the Deal"

The phase code for a sales stage.
QuotaFactor: number

Title: Quota Factor

The quota factor for a sales stage.
RcmndWinProb: number

Title: Win Probability

Default Value: 0

The recommended win probability of the sales stage.
SalesMethodId: integer (int64)

Title: Sales Method ID

The unique identifier of the sales method to which the sales stage belongs.
SalesStageProcessSteps: array Sales Stage Process Steps

Title: Sales Stage Process Steps

The sales stage process steps resource is used view the sales stage process steps. It is a sequence of recommended steps tied to a particular sales stage which is used to guide the sales representative through the opportunity lifecycle.
SetId: string

The unique identifier of the sales stage set. The value is retrieved from the sales method set identifier.
StageNumber: string

Maximum Length: 64

A GUID-based column that has been created to be part of alternate key for data migration.
StageStatusCd: string

Title: Status

Maximum Length: 30

Default Value: "Open"

The status of the sales stage.
StgId: integer (int64)

The unique identifier of the sales stage.
StgOrder: number

Title: Order

The sales stage order within a sales method.
UserLastUpdateDate: string (date-time)

The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as different mobile database, or the server.

{
    "type":"object",
    "properties":{
        "StageNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"A GUID-based column that has been created to be part of alternate key for data migration.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesMethodId":{
            "title":"Sales Method ID",
            "type":"integer",
            "description":"The unique identifier of the sales method to which the sales stage belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StgId":{
            "type":"integer",
            "description":"The unique identifier of the sales stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AverageDaysAtStage":{
            "title":"Duration",
            "type":"integer",
            "description":"The average number of days of sales stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as different mobile database, or the server.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-Attachments-item-response"
            }
        },
        "SalesStageProcessSteps":{
            "title":"Sales Stage Process Steps",
            "type":"array",
            "description":"The sales stage process steps resource is used view the sales stage process steps. It is a sequence of recommended steps tied to a particular sales stage which is used to guide the sales representative through the opportunity lifecycle.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-SalesStageProcessSteps-item-response"
            }
        },
        "StgOrder":{
            "title":"Order",
            "type":"number",
            "description":"The sales stage order within a sales method.",
            "nullable":false,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the sales stage.",
            "nullable":false,
            "x-queryable":true
        },
        "QuotaFactor":{
            "title":"Quota Factor",
            "type":"number",
            "description":"The quota factor for a sales stage.",
            "nullable":false,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            },
            "x-queryable":true
        },
        "StageStatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the sales stage.",
            "nullable":true,
            "default":"\"Open\"",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumDaysInStage":{
            "title":"Stalled Deal Limit",
            "type":"integer",
            "description":"The maximum number of days of a sales stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "RcmndWinProb":{
            "title":"Win Probability",
            "type":"number",
            "description":"The recommended win probability of the sales stage.",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "precision":"22",
                "scale":"7"
            },
            "x-queryable":true
        },
        "PhaseCd":{
            "title":"Phase",
            "maxLength":"30",
            "type":"string",
            "description":"The phase code for a sales stage.",
            "nullable":false,
            "default":"\"B - Working the Deal\"",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"2",
            "type":"boolean",
            "description":"Indicates whether the sales stage has been deleted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the sales stage.",
            "nullable":true,
            "x-queryable":true
        },
        "SetId":{
            "type":"string",
            "description":"The unique identifier of the sales stage set. The value is retrieved from the sales method set identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentEntityName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the attachment entity. Default value is MOO_STG_B.",
            "nullable":true,
            "default":"MOO_STG_B",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

Array of: object crmBusinessUnits-salesMethods-SalesStage-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-Attachments-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 : Sales Stage Process Steps

Type: array

Title: Sales Stage Process Steps

The sales stage process steps resource is used view the sales stage process steps. It is a sequence of recommended steps tied to a particular sales stage which is used to guide the sales representative through the opportunity lifecycle.

Show Source

Array of: object crmBusinessUnits-salesMethods-SalesStage-SalesStageProcessSteps-item-response

{
    "title":"Sales Stage Process Steps",
    "type":"array",
    "description":"The sales stage process steps resource is used view the sales stage process steps. It is a sequence of recommended steps tied to a particular sales stage which is used to guide the sales representative through the opportunity lifecycle.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-SalesStageProcessSteps-item-response"
    }
}

Nested Schema : crmBusinessUnits-salesMethods-SalesStage-Attachments-item-response

Type: object

Show Source

AsyncTrackerId: string

Title: Asynchronous Upload Tracker Id

Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
AttachedDocumentId: integer (int64)

Title: Attached Document Id

The unique identifier of the attached document.
CategoryName: string

Title: Category

Maximum Length: 30

The category of the attachment.
ContentRepositoryFileShared: boolean

Title: Shared

Indicates whether the attachment is shared.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 255

The user who created the record.
CreatedByUserName: string

Title: Created By User Name

Read Only: true

The user name who created the record.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the record was created.
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE

The value that indicates the data type code of the attachment.
Description: string

Title: Description

Maximum Length: 255

The description of the attachment.
DmDocumentId: string

Maximum Length: 255

The document ID from which the attachment is created.
DmFolderPath: string

Title: Dm Folder Path

Maximum Length: 1000

The folder path from which the attachment is created.
DmVersionNumber: string

Maximum Length: 255

The document version number from which the attachment is created.
DownloadInfo: string

Title: DownloadInfo

JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode: string

Title: Error Status Code

The error code, if any, for the attachment.
ErrorStatusMessage: string

Title: Error Status Message

The error message, if any, for the attachment.
ExpirationDate: string (date-time)

Title: Expiration Date

The date when the contents in the attachment expire.
FileContents: string (byte)

Title: File Contents

The contents of the attachment.
FileName: string

Title: File Name

Maximum Length: 2048

The file name of the attachment.
FileUrl: string

Title: File Url

The URL of the attachment file.
FileWebImage: string (byte)

Title: File Web Image

Read Only: true

The base64 encoded image of the file displayed in .png format if the source is a convertible image.
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: 255

The user who last updated the record.
LastUpdatedByUserName: string

Title: Last Updated By User

Read Only: true

The user name who last updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
PostProcessingAction: string

Title: PostProcessingAction

The name of the action that can be performed after an attachment is uploaded.
Title: string

Title: Title

The title of the attachment.
UploadedFileContentType: string

Title: Uploaded File Content Type

The content type of the attachment.
UploadedFileLength: integer

Title: File Size

The size of the attachment file.
UploadedFileName: string

Title: Uploaded File Name

The name to assign to a new attachment file.
UploadedText: string

Title: Uploaded Text

The text content for a new text attachment.
Uri: string

Title: Uri

Maximum Length: 4000

The URI of a Topology Manager type attachment.
Url: string

Title: Url

Maximum Length: 4000

The URL of a web page type attachment.
UserName: string

Title: User Name

Read Only: true

Maximum Length: 255

The login credentials of the user who created the attachment.

{
    "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-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The value that indicates the data type code of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : crmBusinessUnits-salesMethods-SalesStage-SalesStageProcessSteps-item-response

Type: object

Show Source

ConflictId: integer (int64)

Default Value: 0

The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Read Only: true

The date and time when the record was created.
DescriptionText: string

Title: Description

Maximum Length: 4000

The details of the process step.
LastUpdateDate: string (date-time)

Read Only: true

The date and time when the record was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

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.
Name: string

Title: Name

Maximum Length: 200

The name of the process step.
StepSequenceNumber: integer (int64)

Title: Order

The sequence number of the process step within sales stage.
StgId: integer (int64)

The unique identifier of the sales stage that the process step is a part of.
StgProcessStepId: integer (int64)

The identifier of the sales stage process step.
StgProcessStepNumber: string

Maximum Length: 64

The GUID-based column that has been created to be part of alternate key for data migration.
UserLastUpdateDate: string (date-time)

The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as different mobile database, or the server.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StgId":{
            "type":"integer",
            "description":"The unique identifier of the sales stage that the process step is a part of.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StgProcessStepId":{
            "type":"integer",
            "description":"The identifier of the sales stage process step.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as different mobile database, or the server.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the process step.",
            "nullable":false,
            "x-queryable":true
        },
        "StgProcessStepNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The GUID-based column that has been created to be part of alternate key for data migration.",
            "nullable":true,
            "x-queryable":true
        },
        "StepSequenceNumber":{
            "title":"Order",
            "type":"integer",
            "description":"The sequence number of the process step within sales stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The details of the process step.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "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

assessmentTemplates

Operation: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates

Parameters:

crmBusinessUnitsUniqID: $request.path.crmBusinessUnitsUniqID

The assesment templates resource is used to view the assesment templates. It stores the templates associated with assessments.

fndCommonSetIdLookups

Operation: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/fndCommonSetIdLookups

Parameters:

crmBusinessUnitsUniqID: $request.path.crmBusinessUnitsUniqID

The common set id lookups resource is used to view lookup values for set id enabled lookup types.

optyStatus

Operation: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/optyStatus

Parameters:

crmBusinessUnitsUniqID: $request.path.crmBusinessUnitsUniqID

The opportunity status values resource is used to view the opportunity status value. The configurable setup data is defined specifically for sales usage.

salesMethods

Operation: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods

Parameters:

crmBusinessUnitsUniqID: $request.path.crmBusinessUnitsUniqID