Jump to

• Request
• Response
• Examples

Get all parameters

get

/fscmRestApi/resources/11.13.18.05/recallParameters

Request

Query Parameters

• 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: Find recall parameters according to the parameter identifier.
    Finder Variables:
    • ParameterId; integer; Value that uniquely identifies the recall parameter.
• 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:
  

  • CreatedBy; string; User who created the record.
  • CreationDate; string; Date and time when the user created the record.
  • Description; string; Descriptions of the parameter required to be set up for product recall management.
  • LastUpdateDate; string; Date and time when the user most recently updated the record.
  • LastUpdateLogin; string; Login that the user used when updating the document.
  • LastUpdatedBy; string; User who most recently updated the record.
  • Name; string; Name of the parameter required to be set up for product recall management.
  • ObjectVersionNumber; integer; Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time 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.
  • ParameterCode; string; Abbreviation that identifies the parameter required to be set up for product recall management.
  • ParameterId; integer; Value that uniquely identifies the recall parameter.
  • ParameterLevelCode; string; Abbreviation that identifies the level at which a particular parameter has to be set up that includes business unit and inventory organization.
  • SeedDataSource; string; Source of the predefined data that consists of the parameters required to be set up for product recall management.
• 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 : recallParameters

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/recallParameters-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recallParameters-item-response

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• Description: string
  Maximum Length: 240

  Descriptions of the parameter required to be set up for product recall management.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 60

  Name of the parameter required to be set up for product recall management.
• ObjectVersionNumber: integer (int32)
  Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time 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.
• ParameterCode: string
  Maximum Length: 60

  Abbreviation that identifies the parameter required to be set up for product recall management.
• ParameterId: integer (int64)
  Value that uniquely identifies the recall parameter.
• ParameterLevelCode: string
  Maximum Length: 60

  Abbreviation that identifies the level at which a particular parameter has to be set up that includes business unit and inventory organization.
• SeedDataSource: string
  Maximum Length: 60

  Source of the predefined data that consists of the parameters required to be set up for product recall management.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Descriptions of the parameter required to be set up for product recall management.",
            "nullable":true,
            "x-queryable":true
        },
        "ParameterLevelCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Abbreviation that identifies the level at which a particular parameter has to be set up that includes business unit and inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"60",
            "type":"string",
            "description":"Source of the predefined data that consists of the parameters required to be set up for product recall management.",
            "nullable":true,
            "x-queryable":true
        },
        "ParameterCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Abbreviation that identifies the parameter required to be set up for product recall management.",
            "nullable":true,
            "x-queryable":true
        },
        "ParameterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall parameter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the parameter required to be set up for product recall management.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time 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,
            "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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "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 : 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

Examples

This example describes how to get all parameters.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/recallParameters"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"CreatedBy": "SEED_DATA_FROM_APPLICATION",
		"CreationDate": "2020-06-02T18:02:22+00:00",
		"Description": "Specify if the product traceability grouping and task assignment must happen at the Inventory Organization, Location, or Subinventory level.",
		"LastUpdateDate": "2020-06-02T18:02:22.069+00:00",
		"LastUpdateLogin": "-1",
		"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
		"Name": "Product Traceability Grouping",
		"ObjectVersionNumber": 1,
		"ParameterCode": "SCH_PRODUCT_TRACE_GROUPING",
		"ParameterId": 300100207305644,
		"ParameterLevelCode": "Inventory Organization",
		"SeedDataSource": "./RecallParameterSD.xml",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/recallParameters/300100207305644",
			"name": "recallParameters",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/recallParameters/300100207305644",
			"name": "recallParameters",
			"kind": "item"
		}
		]
	},
	{
		"CreatedBy": "SEED_DATA_FROM_APPLICATION",
		"CreationDate": "2020-06-02T18:02:22.161+00:00",
		"Description": "Select a default item validation organization against each business unit in which the recall notice will be captured.",
		"LastUpdateDate": "2020-06-02T18:02:22.165+00:00",
		"LastUpdateLogin": "-1",
		"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
		"Name": "Item Validation Organization",
		"ObjectVersionNumber": 1,
		"ParameterCode": "SCH_RECALL_ITEM_VALIDATION_ORG",
		"ParameterId": 300100207305645,
		"ParameterLevelCode": "Business Unit",
		"SeedDataSource": "./RecallParameterSD.xml",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/recallParameters/300100207305645",
			"name": "recallParameters",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/recallParameters/300100207305645",
			"name": "recallParameters",
			"kind": "item"
		}
		]
	},
	{
		"CreatedBy": "SEED_DATA_FROM_APPLICATION",
		"CreationDate": "2020-06-02T18:02:22.172+00:00",
		"Description": "Specify the starting number of the sequence for the recall notice number generation. You can also optionally add a prefix for each BU.",
		"LastUpdateDate": "2020-06-02T18:02:22.176+00:00",
		"LastUpdateLogin": "-1",
		"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
		"Name": "Recall Notice Document Number Sequencing",
		"ObjectVersionNumber": 1,
		"ParameterCode": "SCH_RECALL_NOTICE_DOC_SEQ",
		"ParameterId": 300100207305646,
		"ParameterLevelCode": "Business Unit",
		"SeedDataSource": "./RecallParameterSD.xml",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/recallParameters/300100207305646",
			"name": "recallParameters",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/recallParameters/300100207305646",
			"name": "recallParameters",
			"kind": "item"
		}
		]
	},
	{
		"CreatedBy": "SEED_DATA_FROM_APPLICATION",
		"CreationDate": "2020-06-02T18:02:22.185+00:00",
		"Description": "Select a default recall subinventory and stock locator against each inventory organization in which the recalled parts will get quarantined.",
		"LastUpdateDate": "2020-06-02T18:02:22.189+00:00",
		"LastUpdateLogin": "-1",
		"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
		"Name": "Recall Subinventory and Stock Locator",
		"ObjectVersionNumber": 1,
		"ParameterCode": "SCH_RECALL_SUBINV_LOC",
		"ParameterId": 300100207305647,
		"ParameterLevelCode": "Inventory Organization",
		"SeedDataSource": "./RecallParameterSD.xml",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/recallParameters/300100207305647",
			"name": "recallParameters",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/recallParameters/300100207305647",
			"name": "recallParameters",
			"kind": "item"
		}
		]
	}
	],
	"count": 4,
	"hasMore": false,
	"limit": 4,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/recallParameters",
		"name": "recallParameters",
		"kind": "collection"
	}
	]
}

Back to Top