Jump to

• Request
• Response

Get all profile fields

get

/fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles/{ProfileId}/child/profileFields

Request

Path Parameters

• ProfileId(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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the data security profile field that matches the profile name.
    Finder Variables
    • ProfileFieldId; integer; The unique identifier of the data security profile field.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignmentFieldName; string; Name of the assignment field used on the security profile.
  • CreatedBy; string; An attribute to store the user name of the person who created the record.
  • CreationDate; string; Date when the record was created.
  • FieldDataType; string; Data type of the field used for the security profile.
  • FieldDescription; string; Description of the field used for the security profile.
  • FieldDisplay; string; Display value of the field used for the security profile.
  • FieldId; integer; Unique identifier of the field.
  • FieldLOVDisplayFields; string; The comma separated list of list of value resource field names that's used to get the value from for display purposes.
  • FieldLOVResourcePath; string; The list of values resource path to get the list of values for this field.
  • FieldLOVSourceField; string; The field name of the list of value resource to get the value from for the assignment to the business object field.
  • FieldOperatorCode; string; Unique identifier of the field operator used for the security profile.
  • LastUpdateDate; string; Date when the record was last updated.
  • LastUpdatedBy; string; User name of the person who last updated the record.
  • ProfileFieldId; integer; Unique identifier of the security profile.
  • SupportMultiValueFlag; boolean; Field used to store the indicator for multiple values for the security profile.
  • SupportNullValueFlag; boolean; Field used to store the indicator for a Null attribute for the security profile.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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

Body ()

Root Schema : hedDataSecurityProfiles-profileFields

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/hedDataSecurityProfiles-profileFields-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hedDataSecurityProfiles-profileFields-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/hedDataSecurityProfiles-profileFields-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 : hedDataSecurityProfiles-profileFields-item-response

Type: object

Show Source

• AssignmentFieldName: string
  Title: Assignment Field Name

  Read Only: true

  Maximum Length: 50

  Name of the 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

  Unique identifier of the field.
• FieldLOVDisplayFields: string
  Title: Field LOV Display Fields

  Read Only: true

  Maximum Length: 50

  The comma separated list of list of value resource field names that's used to get the value from for display purposes.
• FieldLOVResourcePath: string
  Title: Field LOV Resource Path

  Read Only: true

  Maximum Length: 250

  The list of values resource path to get the list of values for this field.
• FieldLOVSourceField: string
  Title: Field LOV Source Field

  Read Only: true

  Maximum Length: 50

  The field name of the list of value resource to get the value from for the assignment to the business object field.
• 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.
• ProfileFieldId: integer (int64)
  Title: Profile Field ID

  Read Only: true

  Unique identifier of the security profile.
• 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-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FieldLOVResourcePath":{
            "title":"Field LOV Resource Path",
            "maxLength":"250",
            "type":"string",
            "description":"The list of values resource path to get the list of values for this field.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProfileFieldId":{
            "title":"Profile Field ID",
            "type":"integer",
            "description":"Unique identifier of the security profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FieldLOVDisplayFields":{
            "title":"Field LOV Display Fields",
            "maxLength":"50",
            "type":"string",
            "description":"The comma separated list of list of value resource field names that's used to get the value from for display purposes.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FieldId":{
            "title":"Field",
            "type":"integer",
            "description":"Unique identifier of the field.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FieldLOVSourceField":{
            "title":"Field LOV Source Field",
            "maxLength":"50",
            "type":"string",
            "description":"The field name of the list of value resource to get the value from for the assignment to the business object field.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignmentFieldName":{
            "title":"Assignment Field Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the assignment field used on the security profile.",
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "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."
        }
    }
}

Back to Top