Jump to

• Request
• Response

Get a business object

get

/fscmRestApi/resources/11.13.18.05/hedBusinessObjects/{ObjectId}

Request

Path Parameters

• ObjectId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : hedBusinessObjects-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  An attribute to store the user name of the person who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• dataPrivileges: array Business Objects
  Title: Business Objects

  The data privileges resource provides a list of data security privileges granted to the data condition assigned to the data security profile assignee.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  User name of the person who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 2000

  Description of the business object used to configure data security.
• ObjectId: integer (int64)
  Read Only: true

  Unique identifier of the business object used to configure data security.
• ObjectName: string
  Title: Business Object

  Read Only: true

  Maximum Length: 240

  Name of the business object used for data security.
• securityFields: array Business Objects
  Title: Business Objects

  The security fields resource provides a list of fields that can be used to secure a business object.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User name of the person who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"An attribute to store the user name of the person who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Unique identifier of the business object used to configure data security.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "dataPrivileges":{
            "title":"Business Objects",
            "type":"array",
            "description":"The data privileges resource provides a list of data security privileges granted to the data condition assigned to the data security profile assignee.",
            "items":{
                "$ref":"#/components/schemas/hedBusinessObjects-dataPrivileges-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectDescription":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the business object used to configure data security.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectName":{
            "title":"Business Object",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business object used for data security.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "securityFields":{
            "title":"Business Objects",
            "type":"array",
            "description":"The security fields resource provides a list of fields that can be used to secure a business object.",
            "items":{
                "$ref":"#/components/schemas/hedBusinessObjects-securityFields-item-response"
            }
        }
    }
}

Nested Schema : Business Objects

Type: array

Title: Business Objects

The data privileges resource provides a list of data security privileges granted to the data condition assigned to the data security profile assignee.

Show Source

• Array of: object hedBusinessObjects-dataPrivileges-item-response

{
    "title":"Business Objects",
    "type":"array",
    "description":"The data privileges resource provides a list of data security privileges granted to the data condition assigned to the data security profile assignee.",
    "items":{
        "$ref":"#/components/schemas/hedBusinessObjects-dataPrivileges-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 : Business Objects

Type: array

Title: Business Objects

The security fields resource provides a list of fields that can be used to secure a business object.

Show Source

• Array of: object hedBusinessObjects-securityFields-item-response

{
    "title":"Business Objects",
    "type":"array",
    "description":"The security fields resource provides a list of fields that can be used to secure a business object.",
    "items":{
        "$ref":"#/components/schemas/hedBusinessObjects-securityFields-item-response"
    }
}

Nested Schema : hedBusinessObjects-dataPrivileges-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrivilegeDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 512

  Description for the data privilege associated with the business object.
• PrivilegeId: integer (int64)
  Title: Data Privilege ID

  Read Only: true

  Unique sequence generated identifier for the data privilege associated with the business object.
• PrivilegeName: string
  Title: Data Privilege Name

  Read Only: true

  Maximum Length: 400

  Unique name for the data privilege associated with the business object.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PrivilegeDescription":{
            "title":"Description",
            "maxLength":512,
            "type":"string",
            "description":"Description for the data privilege associated with the business object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrivilegeId":{
            "title":"Data Privilege ID",
            "type":"integer",
            "description":"Unique sequence generated identifier for the data privilege associated with the business object.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrivilegeName":{
            "title":"Data Privilege Name",
            "maxLength":400,
            "type":"string",
            "description":"Unique name for the data privilege associated with the business object.",
            "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 : hedBusinessObjects-securityFields-item-response

Type: object

Show Source

• AssignmentFieldName: string
  Title: Assignment Field Name

  Read Only: true

  Maximum Length: 50

  Name of the field assignment field used on the security profile.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  An attribute to store the user name of the person who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• FieldDataType: string
  Title: Field Data Type

  Read Only: true

  Maximum Length: 20

  Data type of the field used for the security profile.
• FieldDescription: string
  Title: Field Description

  Read Only: true

  Maximum Length: 1000

  Description of the field used for the security profile.
• FieldDisplay: string
  Title: Field Display

  Read Only: true

  Maximum Length: 100

  Display value of the field used for the security profile.
• FieldId: integer (int64)
  Title: Field

  Read Only: true

  Unique identifier of a field used to set up the security profile for data security.
• FieldLovDisplayFields: string
  Title: Field LOV Display Fields

  Read Only: true

  Maximum Length: 50

  Field for the list of values of the display fields used for the security profile.
• FieldLovResourcePath: string
  Title: Field LOV Resource Path

  Read Only: true

  Maximum Length: 250

  List of values of the resource path for the field used for the security profile.
• FieldLovSourceField: string
  Title: Field LOV Source Field

  Read Only: true

  Maximum Length: 50

  Source of the list of values for a field used for the security profile.
• FieldOperatorCode: string
  Title: Field Operator Code

  Read Only: true

  Maximum Length: 30

  Unique identifier of the field operator used for the security profile.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  User name of the person who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SupportMultiValueFlag: boolean
  Title: Field Multiple Value Indicator

  Read Only: true

  Maximum Length: 1

  Field used to store the indicator for multiple values for the security profile.
• SupportNullValueFlag: boolean
  Title: Field Null Value Indicator

  Read Only: true

  Maximum Length: 1

  Field used to store the indicator for a Null attribute for the security profile.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User name of the person who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldDataType":{
            "title":"Field Data Type",
            "maxLength":20,
            "type":"string",
            "description":"Data type of the field used for the security profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"An attribute to store the user name of the person who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldDisplay":{
            "title":"Field Display",
            "maxLength":100,
            "type":"string",
            "description":"Display value of the field used for the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldLovResourcePath":{
            "title":"Field LOV Resource Path",
            "maxLength":250,
            "type":"string",
            "description":"List of values of the resource path for the field used for the security profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupportNullValueFlag":{
            "title":"Field Null Value Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Field used to store the indicator for a Null attribute for the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldDescription":{
            "title":"Field Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the field used for the security profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldOperatorCode":{
            "title":"Field Operator Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the field operator used for the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldLovSourceField":{
            "title":"Field LOV Source Field",
            "maxLength":50,
            "type":"string",
            "description":"Source of the list of values for a field used for the security profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupportMultiValueFlag":{
            "title":"Field Multiple Value Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Field used to store the indicator for multiple values for the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldLovDisplayFields":{
            "title":"Field LOV Display Fields",
            "maxLength":50,
            "type":"string",
            "description":"Field for the list of values of the display fields used for the security profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldId":{
            "title":"Field",
            "type":"integer",
            "description":"Unique identifier of a field used to set up the security profile for data security.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssignmentFieldName":{
            "title":"Assignment Field Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the field assignment field used on the security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "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"
    }
}

Links

dataPrivileges

Operation: /fscmRestApi/resources/11.13.18.05/hedBusinessObjects/{ObjectId}/child/dataPrivileges

Parameters:

• ObjectId: $request.path.ObjectId

The data privileges resource provides a list of data security privileges granted to the data condition assigned to the data security profile assignee.

securityFields

Operation: /fscmRestApi/resources/11.13.18.05/hedBusinessObjects/{ObjectId}/child/securityFields

Parameters:

• ObjectId: $request.path.ObjectId

The data privileges resource provides a list of data security privileges granted to the data condition assigned to the data security profile assignee.

Back to Top