Jump to

• Request
• Response

Create an export criteria

post

/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports/{OfferingCode}/child/SetupOfferingCSVExportCriteria

Create an export criteria

Request

Path Parameters

• OfferingCode(required): string
  The short code of the setup offering. This attribute is required.

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttributeName: string
  Title: Attribute Name

  Name of the attribute that defines the filter criteria for the business object.
• AttributeSet: string
  Title: Attribute Set

  Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.
• AttributeValue: string
  Title: Attribute Value

  Value applicable to the attribute that defines the filter criteria for a business object.
• BusinessObjectCode: string
  Title: Business Object Code

  The unique code of the business object.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area.
• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the export process.

{ "type":"object", "properties":{ "OfferingCode":{ "title":"Offering Code", "type":"string", "description":"The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "BusinessObjectCode":{ "title":"Business Object Code", "type":"string", "description":"The unique code of the business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeSet":{ "title":"Attribute Set", "type":"string", "description":"Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeName":{ "title":"Attribute Name", "type":"string", "description":"Name of the attribute that defines the filter criteria for the business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeValue":{ "title":"Attribute Value", "type":"string", "description":"Value applicable to the attribute that defines the filter criteria for a business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } } } }

Request Body - application/vnd.oracle.adf.resourceitem+json ()

Root Schema : schema

Type: object

Show Source

• AttributeName: string
  Title: Attribute Name

  Name of the attribute that defines the filter criteria for the business object.
• AttributeSet: string
  Title: Attribute Set

  Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.
• AttributeValue: string
  Title: Attribute Value

  Value applicable to the attribute that defines the filter criteria for a business object.
• BusinessObjectCode: string
  Title: Business Object Code

  The unique code of the business object.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area.
• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the export process.

{ "type":"object", "properties":{ "OfferingCode":{ "title":"Offering Code", "type":"string", "description":"The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "BusinessObjectCode":{ "title":"Business Object Code", "type":"string", "description":"The unique code of the business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeSet":{ "title":"Attribute Set", "type":"string", "description":"Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeName":{ "title":"Attribute Name", "type":"string", "description":"Name of the attribute that defines the filter criteria for the business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeValue":{ "title":"Attribute Value", "type":"string", "description":"Value applicable to the attribute that defines the filter criteria for a business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } } } }

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item-response

Match All

Show Source

• object ItemProperties
• object schema

{ "allOf":[ { "$ref":"#/components/schemas/ItemProperties" }, { "$ref":"#/components/schemas/setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item" } ] }

Nested Schema : ItemProperties

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{ "type":"object", "properties":{ "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } } } }

Nested Schema : schema

Type: object

Show Source

• AttributeName: string
  Title: Attribute Name

  Name of the attribute that defines the filter criteria for the business object.
• AttributeSet: string
  Title: Attribute Set

  Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.
• AttributeValue: string
  Title: Attribute Value

  Value applicable to the attribute that defines the filter criteria for a business object.
• BusinessObjectCode: string
  Title: Business Object Code

  The unique code of the business object.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area.
• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the export process.

{ "type":"object", "properties":{ "OfferingCode":{ "title":"Offering Code", "type":"string", "description":"The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "BusinessObjectCode":{ "title":"Business Object Code", "type":"string", "description":"The unique code of the business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeSet":{ "title":"Attribute Set", "type":"string", "description":"Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeName":{ "title":"Attribute Name", "type":"string", "description":"Name of the attribute that defines the filter criteria for the business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeValue":{ "title":"Attribute Value", "type":"string", "description":"Value applicable to the attribute that defines the filter criteria for a business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":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