Get Lines
get
/campaigns/{gtmCampaignGid}/lines
Request
Path Parameters
-
gtmCampaignGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : campaigns.lines
Type:
Show Source
object
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate11:
attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate12:
attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate13:
attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate14:
attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate15:
attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate16:
attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate17:
attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate18:
attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate19:
attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate20:
attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber11: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber12: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber13: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber14: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber15: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber16: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber17: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber18: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber19: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber20: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
classificationCode: string
The classification code associated with the classification type.
-
countryOfOrigin: string
The country of origin of the goods on the campaign line.
-
domainName: string
Database domain where this data is stored.
-
gtmCampaignLineGid: string
The GID for the GTM campaign line.
-
gtmCampaignLineXid: string
The XID for the GTM campaign line.
-
gtmProdClassTypeGid: string
The GID for the product classification type assigned to the GTM campaign line.
-
indicator: string
Marks the condition or state of the GTM campaign line using colors.
-
involvedParties:
involvedParties
-
isQualified: string
Indicates if an item qualified for a trade agreement. Can have "Y","N" and "NS" and default value is "NS"
-
itemGid: string
This column stores the Item GID for which the Campaign Line is created.
-
lineDescription: string
The description for the campaign line.
-
links: array
links
Read Only:
true
-
notes:
notes
-
originEffectiveDate:
originEffectiveDate
The date on which the country of origin is effective.
-
originExpirationDate:
originExpirationDate
The date on which the country of origin expires.
-
partnerItemGid: string
The GID for the GTM trading partner item.
-
partySiteGid: string
The GID for the party site associated with the GTM campaign line.
-
producer: string
Indicates the producer of the goods.
-
qfEffectiveDate:
qfEffectiveDate
The date on which the qualification for a trade program is effective.
-
qfExpirationDate:
qfExpirationDate
The date on which the qualification for a trade program expires.
-
qfPreferenceCriteriaGid: string
The GID for the preference criteria related to the trade program for which the goods qualify.
-
qfRvcMethodGid: string
The GID for the regional value content method related to the trade program for which the goods qualify.
-
refnums:
refnums
-
remarks:
remarks
-
reqdocs:
reqdocs
-
rvcPercentage: number
(double)
Field for Regional Value Content Percentage
-
statuses:
statuses
-
userDefined1IconGid: string
Marks the condition or state of the GTM campaign line using images. It is a foreign key reference to ICON table.
-
userDefined2IconGid: string
Marks the condition or state of the GTM campaign line using images. It is a foreign key reference to ICON table.
-
userDefined3IconGid: string
Marks the condition or state of the GTM campaign line using images. It is a foreign key reference to ICON table.
-
userDefined4IconGid: string
Marks the condition or state of the GTM campaign line using images. It is a foreign key reference to ICON table.
-
userDefined5IconGid: string
Marks the condition or state of the GTM campaign line using images. It is a foreign key reference to ICON table.
-
values:
values
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : notes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : originEffectiveDate
The date on which the country of origin is effective.
Match All
Show Source
Nested Schema : originExpirationDate
The date on which the country of origin expires.
Match All
Show Source
Nested Schema : qfEffectiveDate
The date on which the qualification for a trade program is effective.
Match All
Show Source
Nested Schema : qfExpirationDate
The date on which the qualification for a trade program expires.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : reqdocs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : values
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : campaigns.lines.involvedParties
Type:
Show Source
object
-
comMethodGid: string
Unique com method ID across all domains.
-
domainName: string
No description.
-
involvedPartyContactGid: string
Unique contact ID accross all domains.
-
involvedPartyQualGid: string
Unique involved party qualifier ID accross all domains.
-
links: array
links
Read Only:
true
Nested Schema : campaigns.lines.notes
Type:
Show Source
object
-
domainName: string
No description.
-
gtmCaLineNoteSeqNo: number
(int64)
The sequence number for campaign line note.
-
isSystemGenerated: string
No description.
-
links: array
links
Read Only:
true
-
note: string
Holds details note of user or system comment.
-
noteDate:
noteDate
This fields holds the date on which note was added on campaign line.
-
noteEnteredBy: string
User id of user who provides the comment.
-
summary: string
Summery of user or system comment.
Nested Schema : noteDate
This fields holds the date on which note was added on campaign line.
Match All
Show Source
Nested Schema : campaigns.lines.refnums
Type:
Show Source
object
-
domainName: string
No description.
-
gtmCaLineRefnumQualGid: string
This field represents unique campaign line refnum qualifier ID across all domains.
-
links: array
links
Read Only:
true
-
refnumValue: string
The reference number value for campaign line.
Nested Schema : campaigns.lines.remarks
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The unique identifier for the remark qualifier.
-
remarkSequence: number
(int64)
The sequence number for campaign line remark.
-
remarkText: string
Campaign line remark text value.
Nested Schema : campaigns.lines.reqdocs
Type:
Show Source
object
-
docs:
docs
-
documentDefGid: string
Required document type.
-
domainName: string
No description.
-
instructions: string
No description.
-
links: array
links
Read Only:
true
-
numRevisions: number
(int32)
Number of document revisions generated
-
reviewers:
reviewers
-
reviewStatus: string
No description.
-
statuses:
statuses
-
subscribers:
subscribers
-
texts:
texts
Nested Schema : reviewers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : subscribers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : texts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : campaigns.lines.reqdocs.docs
Type:
Show Source
object
-
annotations: string
Document revision annotations
-
documentCmsName: string
The document name used to identify a set of revisions (versions) for a CMS.
-
documentGid: string
Document instance
-
documentRevision: number
(int32)
Document revision count
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
review: string
Document review state
Nested Schema : campaigns.lines.reqdocs.reviewers
Type:
Show Source
object
-
contactGid: string
Reviewer
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : campaigns.lines.reqdocs.statuses
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
Status Type
-
statusValueGid: string
Status Value
Nested Schema : campaigns.lines.reqdocs.subscribers
Type:
Show Source
object
-
contactGid: string
Subscriber
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : campaigns.lines.reqdocs.texts
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
textTemplateGid: string
Text template ID
Nested Schema : campaigns.lines.statuses
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
This field represents unique status type ID across all domains.
-
statusValueGid: string
This field represents unique status value ID across all domains.
Nested Schema : campaigns.lines.values
Type:
Show Source
object
-
currencyValue:
currencyValue
No description.
-
domainName: string
No description.
-
exchangeRateDate:
exchangeRateDate
No description.
-
exchangeRateGid: string
No description.
-
gtmValueQualifierGid: string
Value qualifier
-
links: array
links
Read Only:
true
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency